phpDocumentor为文档注释定义了一种结构,允许解析器以一种一致的方式解析它们。(:)一句话点点就可以了)
pear list 查看是否安装了phpDocumentor
安装 pear install phpDocumentor
phpdocumentor的使用分命令行模式和web模式,我只尝试了命令行模式:
phpdoc -h 该帮助命令会得到很详细的参数列表,其中:
- -f 要进行分析的文件名,多个文件用英文逗号隔开
- -d 要分析的目录,多个目录用英文逗号分割
- -t 生成文档的存放路径
- -o 输出的文档格式,结构为“输出格式:转换器名:模板目录”,包括HTML帧格式、Smarty模板格式、Windows帮助文件格式、PDF格式。
例如:phpdoc -o HTML:Smarty:default -f test.php -t ./docs
PS:
- 如果注释是中文的,一定要执行 iso-8859-1 到 utf-8 的替换,否则生成出来是乱码。
- PHPDoc块必须以/**注释声明开始,才能成为被phpDoc识别的文档注释。
- 标签是由@符号加上一个预定义的标识符表示的,完整的标签列表可参见http://manual.phpdoc.org/。
- PHP代码在被实际执行之前会进行文法解析,即将PHP代码的文法结构转换成二进制格式的操作码(opcodes)。在这个过程中,文法解析器将忽略除文档注释外的所有注释,其注释内容不再出现在opcodes中。而文档注释会被实际解析,且注释内容会成为opcodes的一部分。
参考《PHPer》第19期







