关于记录python源代码的约定和工具有什么用？
公约:PEP 257和PEP 8.请注意,文档字符串可以用reStructuredText编写
用于生成文档的工具:例如Sphinx
首先,使用RestructuredText格式在您的文档字符串中添加注释.
第二,得到狮身人面像.
第三,创建一个使用autodoc扩展的索引.
然后,运行Sphinx以获得非常好的文档.
Epydoc也是一个很好的工具,用于记录源代码,并处理交叉引用类,模块,变量等到 HTML,PDF,LaTeX.绘制一些很好的类继承图.它被许多开源项目使用,因此它得到了相当积极的开发.
将代码文档放在代码本身中是非常好的.看到:
PEP 257 - Docstring约定
PEP 8 - Python代码样式指南
京公网安备 11010802040832号 | 京ICP备19059560号-6 