Sep
18
一直想弄一个手代码手册,以便快速更新手册。但苦于原来的phpdoc问题太多。就自己写了一个解析器(半成品)。还没有来得及写好模板。
今天在研究NetBeans的时候,发现原来有一个叫ApiGen的东西。可以帮助我们生成代码手册。而且质量还不错。
简单写一下教程:
1,准备程序:
* php运行环境(不是服务器哦是直接命令行的环境)
* ApiGen (http://www.apigen.org/)
注:php环境要打开mb_string.dll哦
2,执行命令
好了。这样就可以生把--source定义的目录,生成文档,存放到--destination定义的目录去。
效果嘛
看这里。
重点还是写好注释:
http://phpdoc.org/docs/latest/references/phpdoc/index.html
今天在研究NetBeans的时候,发现原来有一个叫ApiGen的东西。可以帮助我们生成代码手册。而且质量还不错。
简单写一下教程:
1,准备程序:
* php运行环境(不是服务器哦是直接命令行的环境)
* ApiGen (http://www.apigen.org/)
注:php环境要打开mb_string.dll哦
2,执行命令
C:\Users\Administrator>"c:\path\to\php.exe" "c:\path\to\apigen.phar" generate --source="c:\path\to\phpfiles" --destination="c:\path\to\target"
好了。这样就可以生把--source定义的目录,生成文档,存放到--destination定义的目录去。
效果嘛
看这里。
重点还是写好注释:
http://phpdoc.org/docs/latest/references/phpdoc/index.html