欢迎使用¶
开发者最讨厌的两件事: 写文档! 别人不写文档!
“我代码已经足够优美,看代码,哪里还需要什么文档!”、“没有文档让我看什么代码!”,诸如这类的吵架式话题可以在 FizeDoc 终结了!
FizeDoc 解析 PHP 源代码,提取相关代码及注释,生成类库参考文档。
通过生成 ReStructuredText 、Markdown 或者其他标准文档类型,您不再需要编写任何类库文档,只需稍微添加那些必需的描述性文档即可完成文档编写工作。
FizeDoc 需要您的代码注释满足 PHPDoc 规范,相信这个对于代码有处女座情节的您来说不是什么难事!
FizeDoc 自身的文档也是通过 FizeDoc 来生成的,Fize 的各个子项目文档也都使用 FizeDoc 来生成。
以前您需要管理文档,现在您只需要管理代码注释即可,剩下的时间就用来陪好基友或者女朋友吧!~
入门示例¶
使用命令行工具运行如下命令:
fizedoc --dir="code_dir" --namespace=“code_namespace”
其中 code_dir 表示代码文件夹路径,code_namespace 为代码文件夹顶层命名空间。
更多使用方式及配置项请参考…
成功运行后,在当前文件夹下会创建一个 output 文件夹,里面即为生成的文档文件。