问题标签 [docstring]

我想为用 Python 编写的 REST API 生成有用的文档。

我想它应该是这样的：

我的语法显然是：

我想解析这种格式并获得（例如）一个 Python 字典，最好不使用正则表达式。

是否已经有针对这种语法的解析器？
如果不是，那么在 Python 中定义和解析 DSL 的最简单方法是什么？

请注意，我不希望使用 reStructuredText 或任何不同于我描述的格式。

我正在尝试决定将哪些信息放入类文档字符串中以及将哪些信息放入__init__方法文档字符串中。到目前为止，我一直在对类以及如何在类文档字符串中使用它进行概述，而与初始化直接相关的内容（参数详细信息等）我放在__init__文档字符串中。

今天我开始怀疑这是否是正确的方法，所以我查看了几个内置模块，我发现该__init__方法几乎没有文档字符串。根据 PEP8，“非公共方法不需要文档字符串”，但不是 __init__公共的吗？

同样，其他特殊方法，比如__getitem__，__getattr__or __new__，它们应该有文档字符串吗？或者我应该只提他们在类文档字符串中的后果吗？

在 Python 2.5（实际上是 Jython）中，对于 UnitTest TestCase 类 - 没有 SetUpClass 方法，并且__init__不是真正可以接受的（没有参考自我）。当我尝试更改 TestCase 中的文档字符串时：

我越来越：

我试图通过将文档字符串实例化为一个对象（在哪里self.__doc__是可写的）来更改文档字符串。

更新：但我想避免在子类中进行额外的编码（即继承超类函数来设置子类的文档字符串），例如：

文件 DynamicTestCase.py 包括：

文件 MyTestCase.py 包括：

但是，unittest 的运行结果仍然是：

当我期望MyTestCase Docstring = MyTestCase

如何在 python 3.1.x 中打印文档字符串？
我尝试使用 re 和 sys 模块作为测试，但我不断收到错误。谢谢

我想强制 Eclipse 在弹出窗口中显示 Python 的帮助输出而不是整个函数，即给出：

我希望代码辅助弹出窗口只包含“功能描述”而不是“返回 1”

是否有打印帮助（'myfun'）输出的选项。我看到的行为是输出被打印到 std.out 并且脚本等待用户输入（即输入“q”继续）。

必须有一个设置将其设置为仅转储文档字符串。

或者，如果我可以只转储文档字符串加上“def f(args):”行，那也可以。

搜索“python 帮助功能”很可笑。:) 也许我在某个地方错过了一些很好的 pydoc 页面来解释这一切？

我明白了

Windows 7 64 位，Python 2.6

我使用 python 编写了一个相对简单的脚本，还为所有方法编写了文档字符串，如下所示：

但是，当我尝试通过解释器打印文档字符串时，文档字符串被打印为“无”

但是 help(weather) 显示所有文档字符串以及其他信息。那么我在这里做错了吗？如果我是，访问文档字符串的正确方法是什么？

谢谢你。

我发现此宏的在线帮助信息不足。也许 Stackoverflow 可以做得更好？

我正在使用 emacs trunk (24.0.50.1) 以防万一。

谢谢！

我的班级中有一些方法仅供班级的其他方法使用。我在他们的名字前加上'_'。我可以从 epydoc 中隐藏这些功能吗？这是个好主意吗？

我应该使用'_'还是双下划线？老实说，在某些地方阅读了它们之后，我并没有得到区别。此命名约定是否应该仅用于模块/类（实例）函数？还是变量？