Python 中最好的文档化工具
EpyDoc
[http://pycon.org/dc2004/talks/index_html#epydoc Epydoc: an API documentation generation tool]
在年度 Python [http://epydoc.sourceforge.net/pycon-epydoc.html 大会上的讲解(有录像)]
简介
与其它文档化工具一样,EpyDoc 是通过标签区分注释的成份,自动从代码中抓取并生成多格式文档的!
只是! EpyDoc 因为Python 天生的优良品质,快速发展,并且使用非常自然,舒服!
- 嗬嗬嗬!Python 内核中就 由" batteries included" 特性可以得到本身的各种说明
- [wiki:woodpecker/PyBatteriesIncluded 内省的威力]
使用
- 可以自个儿在编程的随时,使用简单的命令输出全部的文档到指定的目录中查看
- [wiki:mailshare/doc/epydoc/using.html Usage]
当然首先,你要使用 EpyDoc 的标签约定来格式化你的注释
- [wiki:mailshare/doc/epydoc/fields.html 语法字段标签]
- 而且还可以利用简单的结构化文本来美化你的文档
[wiki:mailshare/doc/epydoc/epytext.html EpyDoc标记语言]
示范
[http://10.88.15.200/twrite/demo/epydoc/api/ epydoc自身的API文档]
[http://10.88.15.200/twrite/demo/OtterTool/api/ Otter 的API 文档] -- 可以去上一层对照的查看源代码,来理解 EpyDoc 的工作
经验
- 汇集使用 epdoc 的经验