phpDocumentor 及相关资源

phpDocumentor 及相关资源

# 安装

在 php 目录下运行：

go-pear.bat

pear.bat install -o PhpDocumentor

%%

# 命令行参数：

phpdoc -o HTML:frames:earthli -d /phproot/ -t /docs

　　-f 要进行分析的文件名，多个文件用逗号隔开

　　-d 要分析的目录，多个目录用逗号分割

　　-t 生成的文档的存放路径

　　-o 输出的文档格式（即模板），结构为"输出格式:转换器名:模板目录"。

%%

# 常用模板

HTML:Smarty:PHP

HTML:frames:earthli

%%

# 关键的注释语法：

文件头说明：

<?php

/**

 * 说明

 * 

 * @package 文件所属的模块名

 * @filesource

 */

// 其它代码

?>

其它如函数，类，常量的说明，直接用：

<?php

// 其它代码

/**

 * 简单说明

 *

 * 更详细的说明

 */

function name(){}

?>

其它标记及语法，比如函数参数说明，返回值等，参考下面“参考资料”列出的内容。

%%

# 中文乱码

把使用到的模板目录下 template 目录中的 header.tpl ，发送的头信息编码改为项目源代码的编码，比如 gbk 就可以了。

%%

# 参考资料：

写好代码注释，生成代码说明文档，PhpDocumentor

http://www.d5s.cn/archives/88

// 中文乱码

PHPDocumentor安装与使用

http://www.studyday.net/2011/04/196

// 安装

还是phpDocumentor的安装和使用

http://www.tsingfeng.com/?p=160

// 安装，提到 -0 参数

(转载)phpDocumentor筆記

http://www.tsingfeng.com/?p=153

// 比较详细

phpDocumentor

http://baike.baidu.com/view/1269751.htm

// 比较详细

PHPDoc

http://zh.wikipedia.org/wiki/PHPDoc

// 比较详细

phpDoc(PHP Documentor) 标签使用指南

http://lugir.com/book/export/html/290

// 写得很好，可惜内容不完整

phpDocumentor学习记录

http://luchuan.iteye.com/blog/954147

// 可作为补充参考