docstring是一个字符串，它作为模块，函数，类或方法定义中的第一个语句出现，用于记录发生它的对象。
我目前正在使用Sphinx（第一次使用它）来为我的模块构建文档，并且我有一些类具有一些用默认值初始化的类变量。例如：class ...
Python的help（）函数没有打印出我的描述性DocStrings [关闭]
[您好，我正在使用Python 3处理Sublime Text，并制作了一个类。我在方法和类标题下使用docstrings对其进行注释，但是当我尝试使用内置的help（）函数时，它会...
Python文档字符串图像嵌入Python文档字符串中，我有一个reStructuredText指令来显示图像：.. image :: ./images/code_quality.png除了图像以外，我还有一个小图标和一个路径：...] >
为字典关键字添加文档字符串的推荐方法是什么？我正在使用python 2.7和Sphinx。例如，在下面的代码中，我该如何为...
能否在Python 3中获取类型化类属性的DocString？
我搞砸了Python 3中的输入模块，以了解我可以将其扩展到DSL的程度。为了使该DSL可用，我想提取一些用户定义类的DocString，例如：...
如何使Python / Sphinx文档对象属性仅在__init__中声明？
我有带有对象属性的Python类，这些对象属性仅在运行构造函数时声明，例如：class Foo（object）：def __init __（self，base）：self.basepath = base ...
我一直在使用此处描述的Google Docstring格式，但我想知道是否存在用于记录已知类型列表的商定方法。我一直在使用def function（a_list）“”“ ...
Django admindoc无法呈现reStructuredText
我正在使用django admindocs进行文档编制，并且基本功能运行良好（我可以访问文档页面，列出了文档文档中的模型，包括了help_text等）。不幸的是，...
我知道用于为Google样式构建文档字符串的语法，例如：def function_with_types_in_docstring（param1，param2）：“”“示例函数具有文档字符串中记录的类型。...
我得到了一个由以下函数定义的函数：@ bot.command（）async def ping（ctx）：“”“ return pong”“”等待ctx.send（“ pong！”）功能帮助，而不是...
我有以下代码：类注意：def __init __（self，note = None，duration = None，start_time = None）：self.note =注意self.duration =持续时间self.start_time = ...
我想知道编写装饰器类的正确方法是什么，以便它保留装饰函数的文档字符串。例如，考虑以下代码行：import functools class ...
我刚刚开始将docstring添加到我的类/方法中，并且我很难格式化它们，以便在打印时易于阅读。 ...
哪些编程语言元素可以用来记录程序代码，而不违反DRY原理？ [关闭]
可以使用诸如python或java之类的编程语言的哪些元素来记录程序代码，而不违反DRY原理？带有标签DRY的文档生成器是否符合要求？谢谢...
编程语言的哪个元素使得可以在不违反DRY原理的情况下记录程序代码？
诸如python或java之类的编程语言的哪些元素使得可以在不违反DRY原理的情况下记录程序代码？是带有标签的文档字符串还是文档生成器？ ...
我刚开始使用狮身人面像并愿意学习。我想将我的各种功能分解为index.rst文件中的不同部分。因此，每个函数都有其自己的标头。所以...
pydocstyle的错误代码D401读取：第一行应该处于命令状态。我经常遇到以下情况：我写了一个文档字符串，使我的linter抛出了这个错误，然后将其重写-但两个...
我正在编写Python API，并且已经使用Google docstring约定对源代码中的每个类和函数进行了文档记录，我发现它比Sphinx约定更具可读性。我想使用...
我有一个班级：类Holiday（ActivitiesBaseClass）：“”“假日是一项涉及休假的活动”“”“酒店=模型。CharField（max_length = 255）”“”酒店名称“”“我可以...
我有一个班级：类Holiday（ActivitiesBaseClass）：“”“假日是一项涉及休假的活动”“”“酒店=模型。CharField（max_length = 255）”“”酒店名称“”“我可以...