将 pydoc 用于非公共/私人课程

Posted 2023-02-25

【中文标题】将 pydoc 用于非公共/私人课程

【英文标题】：Using pydoc for non-public/private classes

【发布时间】：2012-08-15 22:39:11

【问题描述】：

当我使用 _ 作为类名的前缀时（另请参阅 this 和 this），该类将变为非公开且 pydoc 不会显示：

    class _DoNotShowMeInPydoc:
      """Class Documentation which is not displayed"""

这正是我想要的，因为这个类只在内部使用，对于使用模块的人来说并不重要。

但是 - 如果有人过来想了解我的模块的内部结构，这些（当然）也有文档记录。 pydoc 是否有显示非公共类的标志或选项？

【参考方案1】：

让我们假设文档有各种各样的受众，并且通过与源代码本身分开的文档来阅读代码是有价值的。

Pydoc 几乎不支持任何开关来控制输出。访问级别通常是临时约定，而不是 Python 语言的一部分。

Pydoc 遵循这一点并不容易summarize rules 来决定什么是 private-as-in-do-not-document。所以你唯一的选择是改变你的代码，让它通过 visiblename() 函数。

Pdoc3, a pydoc replacement, uses the __pdoc__ dictionary 覆盖类似于 pydoc 的规则。

我创建了一个fork of pydoc，它默认为所有内容生成文档。