Eqz*_*111 3 python docstring visual-studio-code
要使用 Python Sphinx 生成文档,我必须使用特定的文档字符串格式。
VS Code 扩展autoDocstring能够生成这种特定格式,但如果该函数包含多行字符串,则它不起作用。
本例中的示例有效:
def func(param1, param2, param3):
# docstring nicely generated
"""_summary_
:param param1: _description_
:type param1: _type_
:param param2: _description_
:type param2: _type_
:param param3: _description_
:type param3: _type_
:return: _description_
:rtype: _type_
"""
random_variable = 42
string_variable = "not a multiline string"
return string_variable
Run Code Online (Sandbox Code Playgroud)
但在这种情况下无法生成自动文档字符串:
def func(param1, param2, param3):
# doesn't work
""""""
random_variable = 42
string_variable = """
a
multiline
string
"""
return string_variable
Run Code Online (Sandbox Code Playgroud)
有人知道一个技巧,或者让它发挥作用的东西吗?我在函数中使用了很多多行 SQL 字符串,如果我必须提取这些字符串才能使其正常工作,那么我需要进行大量重构。
| 归档时间: |
|
| 查看次数: |
4566 次 |
| 最近记录: |