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

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

docstring visual-studio-code python

0

JPFrancoia · 技术社区 · 6 年前

我正在与使用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 回复 | 直到 6 年前

1

2

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 ).

推荐文章

moink · 关于模块长度推理和DocString与代码行之比的Pylint消息

7 年前

jon_two · 当docstring需要字符串时,可以传递None参数吗?

7 年前

Brad Solomon · 在类方法docstrings中使用字符串格式

7 年前

Ray Brian Agnew · Python ReST文档字符串中是否有类似C#'s“see cref”的内容?

8 年前

Jimmy C · 为什么我不能对docstring使用format函数?

11 年前

Paul H · 如何获取脚本中的对象列表,以便在每个对象上打印__doc__?

11 年前