使用phpdoc/phpDocumentor来生成api文档

phpDocumentor是一个非常强大的文档自动生成工具,利用它可以帮助我们编写规范的注释,生成易于理解,结构清晰的文档,

对我们的代码升级,维护,移交等都有非常大的帮助。

网上关于phpdoc的文档的介绍虽然不少,但是有点麻烦:

1、网上通常介绍的内容太多,不容易被新手看懂。个人觉得,教程应该本着简单易懂,在能解决问题的前提下,能有多简单就多简单。

更多的内容,应该以附录的形式,或者留下其他更详细的资料链接供读者去阅读(而不是把一大块都复制进自己的文章)

2、phpdoc的安装稍微麻烦。他们没有介绍一种简单易上手的方法给读者

3、phpdoc的默认编码是ISO-8859-1,此时生成的HTML文档会中文乱码。尽管说网上有提供了解决方案——但是,为什么不直接提供一个可支持中文的版本给读者呢?

基于以上几点,我想写篇博文,跟大家分享一个使用phpdoc的简单方法(windows环境下)

在使用phpdoc之前,你首先需要了解代码注释的语法规则(如果你已经懂,请忽略)。

可参考维基本科http://zh.wikipedia.org/wiki/PHPDoc 中关于注释格式的描述部分。

接着,可下载这个经过优化的phpdoc版本:

http://star7th-wordpress.stor.sinaapp.com/uploads/2013/04/phpdoc.zip

下载后解压,比如说解压到”D:/phpdoc”路径下。

用文本编辑器打开phpdoc.bat(注意,不是双击运行),第16行:

SET phpCli=D:\Program Files\php5.3.11\php.exe

将这里的PHP.exe的路径改为你电脑的php环境执行文件所在的路径。(如果你是PHPer,我相信你在本机有安装了php环境吧。)

然后,打开命令提示符。(开始-运行-cmd),在命令行中,进入phpdoc所在的目录,(比如说,输入“cd D:/phpdoc”)。

进入目录后,输入下面的命令,便可快速生成HTML文档:

phpdoc -d D:\website\Api -t D:\website\Api\doc -dn shilianwang -dc shilianwang -ti 事联网文档 -o HTML:Smarty:PHP

上述命令中,D:\website\Api是源php文件所在目录。D:\website\Api\doc 是生成的文档存放目录。

shilianwang是子目录,包、标题。HTML:Smarty:PHP 表示使用HTML模块生成

上面的命令,如果你想详细了解,可在命令行输入phpdoc -h ,了解更多。

最后,附上三种效果图:

注释的样式:

该注释生成的效果图:

PhpDocumentor手册-安装和标签使用

谢谢关注websites博客!

时间: 2024-10-11 21:49:39

使用phpdoc/phpDocumentor来生成api文档的相关文章

PHP的学习--使用PhpDocumentor 2生成API文档

官网地址:http://www.phpdoc.org/ 项目地址:https://github.com/phpDocumentor/phpDocumentor2 phpDocumentor 2是一个可以 分析php源代码和注释块并生成文档的程序. 基于phpdocumentor 1和javadoc启发而来,它持续创新的使用了一些新技术和支持php的新特性. phpDocumentor 2的特点: 兼容php5.3,全面支持命名空间和闭包等. 识别支持任何tag,以及一些追加的 (比如 @link

PHP读取注释生成api文档

总结就是,正则要用的好. 需要生成api的class文件: <?php class emailAction { /** * @method 发送邮件 * @url email/send?token=xxx * @http POST * @param token string [必填] 调用接口凭证 (post|get) * @param ema_type enum [必填] 发送速度:'普通','紧急','延时' * @param ema_from enum [必填] 来源:'B2C','主站'

vs2010代码注释自动生成api文档

最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法 环境:vs2010 先下载安装Sandcastle 和Sandcastle Help File Builder 下载地址 http://sandcastle.codeplex.com/ http://shfb.codeplex.com/ 其中Sandcastle Help File Builder安装较复杂,安装红框内的即可 安装完成后,然后让要使用的项目输出xml

SpringBoot+rest接口+swagger2生成API文档+validator+mybatis+aop+国际化

代码地址:JillWen_SpringBootDemo mybatis 1. 添加依赖: <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>${mybatis.version}</version> </dependency> &

利用sphinx为python项目生成API文档

sphinx可以根据python的注释生成可以查找的api文档,简单记录了下步骤 1:安装 pip install -U Sphinx 2:在需要生成文档的.py文件目录下执行sphinx-apidoc -F -o ./doc ./domain/model/ 在当前目录下新建doc目录,api文档的文件夹就在此目录下,./domain/model/ 表示需要生成api文档的目录. 3:进入doc目录 修改conf.py文件 设置代码路径为sys.path.insert(0, os.path.ab

iOS开发日记23-Xcode生成API文档(HeaderDoc)

今天博主有一个Xcode生成API文档的需求,遇到了一些困难点,在此和大家分享,希望能够共同进步. 今天公司和客户交接源码,但是客户提出不仅需要源码,还需要相应的技术文档,今天博主就和大家分享一下,如何使用Xcode生成你的技术文档. 生成技术文档主要有三个工具: headerdoc, doxygen 和 appledoc.其中headerdoc是苹果官方的生成工具,后两个是第三方工具.如果Xcode版本更新,则需要重新配置第三方工具,个人感觉虽然功能强大,但是配置繁琐,推荐大家使用header

.net 提取注释生成API文档 帮助文档

提取注释生成API文档 一.前言 在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要.通过文档我们快速了解系统各模块的实际接口,及其使用场景.使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险. 对于.Net,我们可以直接将类.方法等的注释直接转为API文档,极大地减少文档维护的工作量,同时也能反向提高大家的注释质量. 下面我们使用.Net唯一的注释生成API文档工具——Sandcastle和Sandcastle Help File Builder来实现API文档

.Net魔法堂:提取注释生成API文档

一.前言 在多人协作的项目中,除了良好的代码规范外,完整的API文档也相当重要.通过文档我们快速了解系统各模块的实际接口,及其使用场景.使用示例,一定程度上降低沟通成本,和减少后期维护中知识遗失等风险. 对于.Net,我们可以直接将类.方法等的注释直接转为API文档,极大地减少文档维护的工作量,同时也能反向提高大家的注释质量. 下面我们使用.Net唯一的注释生成API文档工具——Sandcastle和Sandcastle Help File Builder来实现API文档自动化吧! 二.工具 S

【Unity3D】【NGUI】本地生成API文档

原地址:http://blog.csdn.net/u012091672/article/details/17438135 NGUI讨论群:333417608 1.安装Doxygen(http://www.stack.nl/~dimitri/doxygen/) 2.配置 1)工程名 2)版本 3)源代码目录(根据自己的修改) 4)递归扫描(包含子目录) 5)输出目录 1)只输出可以被文档化的实体 2)c#文档优化 1)有导航栏 2)不使用排版 1)随便指定个目录(用来保存配额) 2)切换到运行界面