python - epydoc 执行 python 文件

Question

我有一个包含多个类的 python 文件，并想使用 epydoc 从我的评论中创建一个文档。所以我在我的 Debian wheezy 系统上的控制台上做：

epydoc --html storage_config_tool.py -o ~/

它始终执行 python 应用程序，文档生成停止在 21%。我使用 epydocgui 时的行为相同。

当我在一个简单的 hello world 程序上对其进行测试时，一切正常。该文件有> 1000行，所以我不能发布它。该程序本身运行良好。

有人知道为什么会这样吗？尽管还找不到任何格式，但格式错误是否会成为问题。

谢谢 4 帮助

Answer 1

没有看到您的代码，很难说出问题所在。但是，听起来好像启动应用程序的代码不受if __name__ == '__main__':语句保护，因此在epydoc导入文件时会运行应用程序。有两件事可能会有所帮助：

1. 修复storage_config_tool.py，以便在导入模块时仅执行class、def和赋值语句。

2. 用于epydoc --html --parse-only storage_config_tool.py -o ~/生成文档。这会跳过模块导入步骤，这可能是生成完整文档所必需的，也可能不是必需的。