问题标签 [docstring]

我正在寻找可以自动为我生成文档字符串框架的 Python IDE。例如：

然后我就可以填写相应的内容了。

我在 Python 中创建了一个类，然后使用 setattr() 添加了一些嵌套类。

但是，调用 help( T ) 不会包含有关 C 的信息。构造一个 T，然后在其中构造一个 C，可以正常工作。

以传统方式执行此操作效果很好：

调用 help( T2 ) 显示有关 C2 的信息。

有人可以解释这里发生了什么吗？谢谢。

我希望能够在我的 PHP5 对象中实现自定义注释，并且我想通过构建自己的解析器来了解整个过程是如何工作的。

不过，首先，我需要知道如何查找注释。

是否有我缺少的反射方法，还是有其他方法？

例如，我希望能够在类中找到以下注释：

我可以将 python doctests 放在每个函数的主体中，我有时喜欢小型库，因为它们与函数在同一个文件中。

或者我可以将它们全部放在一个单独的文件中并执行单独的文件，这很好，以防我不希望函数之间的 doctest。有时我发现如果文档字符串很小，代码更容易处理。

还有一种方法可以将 python doctests 保存在同一个文件中，但将它们放在文件末尾？

编辑：一个解决方案，基于以下接受的答案：

实际上很简单，创建一个虚拟函数作为最后一个函数，该函数在一个文档字符串中包含所有文档测试。

紧跟在类或函数声明之后的 Python 文档字符串被放置在__doc__属性中。

问题：如何提取稍后在函数中出现的其他“内部”文档字符串？

更新：编译器省略了此类文字语句。我可以通过 AST 找到他们（以及他们的行号）吗？

我为什么要问？

我有一个（不完全成熟的）想法来使用这样的“内部”文档字符串来描述敏捷场景的 Given/When/Then 部分：

通过提取文档字符串，测试运行框架可以生成如下输出：

我认为这比 Behave 、 Freshen 、 Lettuce 、 PyCukes 中采用的方法更简洁，后者需要为每个步骤定义一个单独的函数。我不喜欢将步骤文本作为函数名称 ( @When("I add numbers") def add_numbers()) 重复。但与普通的单元测试不同，文档字符串将添加打印出业务可读场景以供参考的能力。

我正在开发一个 Pythonic 命令行“抽认卡”应用程序，以帮助用户学习不同的语言。我想使用 Python 的 cmd 库来加速开发——特别感兴趣的是 cmd.Cmd 类的 do_help() 方法，它打印出类的用户方法的文档字符串。但是，由于此应用程序的多语言特性，我希望能够放入特定语言的文档字符串。

我读了这个关于使用装饰器的 SO question，但我对装饰器知之甚少，我想知道它们是否适合我的特定困境，然后再投入大量时间学习它们。

你们有什么感想？处理这种情况的最佳方法是什么？

如果您想了解有关我的问题的更多信息，请告诉我。

尝试在我自己的类函数上使用Python Omni Completion时，我得到了一些意想不到的结果。函数的文档字符串的格式不正确，换行符如下图所示：

当我从标准 python 库中导入模块时，我得到了我期望的结果：

根据 python文档字符串约定，源文件中的换行符应被解释为换行符。有谁知道这里发生了什么以及如何解决这个问题？

我有一个使用 epydoc 记录的项目。现在我正在尝试切换到狮身人面像。我为 epydocs 格式化了所有文档字符串，使用 B{}、L{} 等进行粗体、链接等，并使用@param、@return、@raise 等来解释输入、输出、异常等。

所以现在我切换到狮身人面像它失去了所有这些功能。是否有一种自动方法可以将 epydocs 格式的文档字符串转换为 sphinx 格式的文档字符串？

我在玩文档字符串，最后得到了这段代码：

这是一个简单的过滤器，我一直在通过串行连接读取数据的项目中使用它，并认为将它用作我第一次尝试编写文档字符串会很好。有没有人有什么建议？我一直在阅读 PEP 257。因为它是一个类，所以关键字参数应该在__init__?

如果有更好的方法来编写它的任何部分（不仅仅是文档字符串），如果人们能指出我正确的方向，我将不胜感激。