PHP代码文档规范及phpDoc指南-共享版.docxVIP

PHP文档规范及phpDoc指南版本内容作者日期1．0初稿焦琨 jkyeah@2012-4目录1概述32PHPDoc/ phpDocumentor32.1什么是PHPDoc/phpDocumentor32.2phpDocumentor1和phpDocumentor252.3phpDocumentor安装52.3.1pear安装52.3.2phpDocumentor安装63使用phpDocumentor生成文档63.1phpDocumentor使用说明63.2生成指定目录下的文档63.3生成指定文件的文档63.4指定文档标题74PHP注释规范74.1需要特别注意的地方74.2文件、类注释84.3方法注释84.4常用tag标签94.4.1常用tag列表94.4.2@param变量类型列表94.5常用的嵌入式{@tag }用法104.5.1{@link}用法104.5.2{@source}用法104.5.3其他inline tag114.6code/code用法115参考资料12概述对于一个开发人员，文档总是最感到头疼的事情之一。而且，很可能你对待文档会采取截然不同的2种态度：当你使用别人的代码库的时候，最希望得到的是它的技术文档，尤其是当时间很紧，而你又不得不硬着头皮去读那些生涩的代码的时候。当写你自己的程序的时候，最不希望做的事情却是给它编写专门的技术文档，你会以种种理由给自己开脱：