docstring是一个字符串，它作为模块，函数，类或方法定义中的第一个语句出现，用于记录发生它的对象。
你如何使用Python中的write（）写一个文档字符串到一个文件？
我使用pytest检查多行文档字符串，我测试，以检查这些多行的方式评论涉及制作一个临时文件，并使用write（）都写在文档字符串，然后...
Python和sphinx：多行google风格docstring中的项目符号列表
我目前正在使用Sphinx记录我的Python项目。在文档字符串的多行部分中包含项目符号列表时，我遇到了一个问题。我想包括一个项目符号......
来自VScode的sphinx和autodocstring与python代码
我正在与使用vscode的人合作开展一个项目。我们编写Python代码。我让他们为他们的函数生成docstrings，他们使用了vscode的Autodocstring。这里有一个 ...
我正在尝试创建一个接受替换字段的docstring，如下所示def run_tests（args）：“”对{0}用法中的方法运行测试：{0} - 测试“”“.format（__ file__）传递但是。 ..
使'Google'成为所有项目PyCharm的默认文档字符串样式
我知道我可以去设置|工具| Python集成工具| Docstrings |文档字符串格式|谷歌，但这只设置当前项目的文档字符串格式（如...所示）
如何在docstring中指定Pandas DataFrame架构/结构？
我想描述我的Python函数所期望的DataFrame结构，以及如下的口头描述：def myfun（input）：“”“有事。参数----------输入：pandas ... 。
我正在尝试在python模块中记录@property，并且无法在文档的帮助中显示docstring。我想打电话来帮助（class.property）只打印帮助...
Pycharm docstring：代码引用和docstring继承
我目前正在浏览Jetbrains Pycharm 2017.1.5中的项目，记录我所有的python 3.6类和方法，并且有几个关于docstring格式的东西。我想链接...
我写测试功能。在docstring中，我经常提到测试用例名称作为摘要行。测试用例描述如下。现在我只需要从...获取测试用例名称（第一行）
对于Python文档，reStructuredText有什么真正的替代品吗？ [关闭]
我很快就开始了一个开源Python项目，我正在尝试提前决定如何编写我的文档字符串。显而易见的答案是使用reStructuredText和Sphinx与autodoc，因为我......
Google格式的功能摘要未显示在PyCharm的快速文档窗口中
PyCharm 2018.3可以选择在文件>设置>工具> Python集成工具>文档字符串格式下更改文档字符串格式选择'谷歌'后，我编写如下代码：def my_func（a，b）：...
Python：如何在包级别帮助菜单中嵌入所有docstring帮助？
我的意思是：TLDR：我如何让我的软件包的帮助包括所有基础文档字符串？我创建了一个包。该软件包具有所有正确的__init__.py文件和所有正确的...
Python“请参阅帮助（类型（自我））以获得准确的签名。”
在帮助（）一个类时，我在许多文档字符串中看到了以下语句：“请参阅帮助（类型（自我））以获得准确的签名。”值得注意的是，它位于scipy.stats.binom .__ init__和...的help（）中。
我刚刚在windows中使用pip安装了pydocstyle：python -m pip install pydocstyle现在当我使用这样的命令运行它时：pycodestyle“Z：/path/to/my/file.py”它打印出一大堆.. 。
我正在编写一个轻量级类，其属性旨在可公开访问，并且有时仅在特定实例中被覆盖。 Python语言中没有提供......
我有一个装饰器，它有一个包装类的嵌套定义。包装器将其包装的原始类维护为属性。玩具示例如下所示：def decorator（cls）：class ...
所以我试图创建一个“动态”文档字符串，它是这样的：ANIMAL_TYPES = [“哺乳动物”，“爬行动物”，“其他”] def func（animalType）：“”“这是一个示例函数。@ param ...
Pycharm：在docstring中自动生成`：type param：`字段
当我使用参数创建一个函数时，PyCharm让我使用：param param_name：field创建docstring，这非常好。但我还需要添加：type param_name：。所以：......
有两种方法可以在代码本身中记录模块，函数或类：注释和文档字符串。 Docstrings功能更强大，因为它们可以通过help（）函数访问，而...
我在用于配置Docopt的docstring中有一些详细的选项规范。有些项目非常冗长。有没有办法包装文本，使其更清晰或......