代码之家 › 专栏 › 技术社区 › JPFrancoia

使用python代码的VScode中的sphinx和autodocstring

docstring visual-studio-code python

JPFrancoia · 技术社区 · 7 年前

我正在与使用vscode的人合作一个项目。我们编写Python代码。我让他们为自己的函数生成docstring,他们使用vscode中的Autodocstring。这是他们想出的文件:

"""
Subclass ObjectCAD renderToFile method to render the scad file
in renders_dir

Arguments:
    file_path {str} -- the destination path for the scad file

Returns:
    None
"""

应该是谷歌风格的docstring。

当我得到这样的东西时:

我是否缺少狮身人面像配置中的选项?或者是Autodocstring断了?

1 回复 | 直到 7 年前

charlie80 6 年前

显示的语法不是Google风格的语法(请参见 here 有关详细示例)。应改为:

"""
Subclass ObjectCAD renderToFile method to render the scad file
in renders_dir

Args:
    file_path (str): the destination path for the scad file

Returns:
    None
"""

autoDocstring 必须正确配置VSCode扩展以生成Google样式的docstring(查找 autoDocstring.docstringFormat ).

推荐文章

Google User · Django管理员在`list_display中未显示`creation_date`字段`

8 月前

user29747013 · 如何创建一个新的数据框架,其中包含原始数据框架中列的聚合列?

8 月前

ÎÎÎ½Î· ÎÎ®Î¹Î½Î¿Ï · Python lxml.html语法错误:使用lxml find时XPATH的谓词无效

8 月前

user29715306 · from_users=和chats=电视节目中的差异

8 月前

Redshoe · 当执行numpy.genfromtxt()时,python是否会读取文件的所有行?

8 月前

RASEL MAHMUD · 为什么以及如何在is_even()函数内的IF条件中递归X变量在满足0后递增?[副本]

8 月前

prayner · 更新嵌套字典包含列表中的项

8 月前

Bringo Jr · 我可以在O(n)中解决这个问题吗?

8 月前

Dave · 如何在for循环中修改列表值

8 月前

Shukurullox Komiljonov · 从记录中获得相互和解。使用SQL

8 月前