phpdoc2操作实例
来源:互联网 发布:软件巡检方案 编辑:程序博客网 时间:2024/04/29 22:46
PHPDocument对于有规范注释的php程序,可以快速生成API文档,以下是安装与使用步骤:
本例环境:windows7,、PHPDocument 2.8.1、php 5.4n、Apache 2.4.9
安装PHPDocument的方法很多,本例采用php pear安装,pear安装配置方法本例不再赘述。
cmd中进入php安装目录,依次执行:
pear channel-discover pear.phpdoc.org(注册phpdoc)
pear remote-list -c phpdoc(获取可安装列表)
pear install phpdoc/phpDocumentor(执行下载安装)
安装过程需要下载文件
安装完成,使用方法:
phpdoc -d "原项目绝对路径" -t "生成api文档的路径"
详细参数可执行 phpdoc -h 进行查询
生成出的html格式文档,可能会出现页面响应时间过长的问题,原因可能是页面对googleapis的引用,修改位置如下:
若安装使用的为PHPDocument 1.x版本,安装和使用过程与此稍有不同。
需要注意的是1.x版本可能会出现生成文档页面不显示或是乱码问题,需要对模板文件做一些修改:
模板位置在 \pear\PhpDocumentor\data\templates
本例模板位置:E:\phpStudy\php54n\pear\PhpDocumentor\data\templates
修改文件(不完全):
header.tpl、index.tpl
删除 <?xml version="1.0" encoding="iso-8859-1"?>
修改 iso-8859-1 => utf-8
0 0
- phpdoc2操作实例
- VI操作实例
- 注册表操作实例
- Hibernate操作视图实例
- java日期操作实例
- java File操作实例
- VC 时间操作实例
- Java文件操作实例
- mysql操作实例
- XML操作实例
- Blob操作实例
- apdcomport操作串口实例
- SQLSERVER操作实例
- 二进制流操作(实例)
- SSH 框架实例 操作
- C#数据库操作实例
- XML操作完整实例
- 图元操作实例
- C++ 嵌套类与外围类以及局部类对成员变量的访问 【数据结构】
- Android在thread中Toast不能显示问题解决
- windows 安裝 gcc 編譯器 - MinGW
- 网络分析与网络数据集—引言
- 测试
- phpdoc2操作实例
- Ioc的实现及应用
- SQLMAP参数中文解说
- mkfifo,open,write,read
- mysqldump导出--数据+结构+(函数+存储过程)
- 运放在开关电源的补偿电路--自控原理要熟悉!!!
- 详解生成静态链接库lib文件和调用
- Bean property 'xxx' is not writable or has an invalid setter method
- Java web----一个简单的客户管理系统(CRM)