没有合适的资源?快使用搜索试试~ 我知道了~
首页PHP文档规范及phpDoc指南-共享版
PHP文档规范及phpDoc指南-共享版
5星 · 超过95%的资源 需积分: 14 43 下载量 73 浏览量
更新于2023-03-16
评论
收藏 886KB DOCX 举报
《PHP文档规范及phpDoc指南-共享版》主要内容是介绍如何写PHP文档和注释,还有phpdoc的使用指南。 适用人群:PHP程序员、工程师、技术经理、架构师和技术总监
资源详情
资源评论
资源推荐
《PHP 文档规范及 phpDoc 指南》
PHP 文档规范及 phpDoc 指南
版本 内容 作者 日期
1.0 初稿 焦琨 jkyeah@hotmail.com
2012-4
第 1 页
《PHP 文档规范及 phpDoc 指南》
目录
1 概述..................................................................................................................................................................... 3
2 PHPDoc/ phpDocumentor.......................................................................................................................... 4
2.1 什么是 PHPDoc/phpDocumentor.................................................................................................................... 4
2.2 phpDocumentor1 和 phpDocumentor2......................................................................................................... 5
2.3 phpDocumentor 安装.......................................................................................................................................... 5
2.3.1 pear 安装................................................................................................................................................................................ 5
2.3.2 phpDocumentor 安装....................................................................................................................................................... 6
3 使用 phpDocumentor 生成文档................................................................................................................. 6
3.1 phpDocumentor 使用说明.................................................................................................................................. 6
3.2 生成指定目录下的文档......................................................................................................................................... 6
3.3 生成指定文件的文档............................................................................................................................................. 7
3.4 指定文档标题.......................................................................................................................................................... 7
4 PHP 注释规范................................................................................................................................................... 7
4.1 需要特别注意的地方............................................................................................................................................. 7
4.2 文件、类注释.......................................................................................................................................................... 8
4.3 方法注释................................................................................................................................................................... 8
4.4 常用 tag 标签........................................................................................................................................................... 9
4.4.1 常用 tag 列表........................................................................................................................................................................ 9
4.4.2 @param 变量类型列表.................................................................................................................................................. 10
4.5 常用的嵌入式{@tag }用法................................................................................................................................. 10
4.5.1 {@link}用法....................................................................................................................................................................... 10
4.5.2 {@source}用法.................................................................................................................................................................. 11
4.5.3 其他 inline tag................................................................................................................................................................... 12
4.6 <code></code>用法.......................................................................................................................................... 12
5 参考资料......................................................................................................................................................... 12
第 2 页
《PHP 文档规范及 phpDoc 指南》
1 概述
对于一个开发人员,文档总是最感到头疼的事情之一。而且,很可能你对待文档会采取截然不同的 2 种
态度:
当你使用别人的代码库的时候,最希望得到的是它的技术文档,尤其是当时间很紧,而你又不得不
硬着头皮去读那些生涩的代码的时候。
当写你自己的程序的时候,最不希望做的事情却是给它编写专门的技术文档,你会以种种理由给自
己开脱:我的代码已经足够清晰了,完全不用再为它重新编写文档了……
为了解决这个问题,文档工具由此产生。按照规范格式编写代码注释,当代码写完了,技术文档也就完
成了。良好的代码注释不仅能够帮助开发人员在编写代码时缕清思路,尽可能避免逻辑 bug,而且规范的代码
注释还能够使用文档工具直接生成 API 手册。
下面是一个规范的代码注释:
/**
* Common base class of all phpdoc classes (简述,用在索引列表中)
*
* As a kind of common base class PhpdocObject holds
* configuration values (e.g. error handling) and debugging
* methods (e.g. introspection()). It does not have a constructor,
* so you can always inheritig Phpdoc classes from this
* class without any trouble. (详细的功能描述)
*
* @author Ulf Wendel
* @version $Id: PhpdocObject.php,v 1.3 2001/02/18 15:29:29 uw Exp $
* @package PHPDoc (文档标记)
*/
class PhpdocObject {
.....
}
第 3 页
剩余12页未读,继续阅读
jkyeah
- 粉丝: 0
- 资源: 2
上传资源 快速赚钱
- 我的内容管理 收起
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
会员权益专享
最新资源
- ExcelVBA中的Range和Cells用法说明.pdf
- 基于单片机的电梯控制模型设计.doc
- 主成分分析和因子分析.pptx
- 共享笔记服务系统论文.doc
- 基于数据治理体系的数据中台实践分享.pptx
- 变压器的铭牌和额定值.pptx
- 计算机网络课程设计报告--用winsock设计Ping应用程序.doc
- 高电压技术课件:第03章 液体和固体介质的电气特性.pdf
- Oracle商务智能精华介绍.pptx
- 基于单片机的输液滴速控制系统设计文档.doc
- dw考试题 5套.pdf
- 学生档案管理系统详细设计说明书.doc
- 操作系统PPT课件.pptx
- 智慧路边停车管理系统方案.pptx
- 【企业内控系列】企业内部控制之人力资源管理控制(17页).doc
- 温度传感器分类与特点.pptx
资源上传下载、课程学习等过程中有任何疑问或建议,欢迎提出宝贵意见哦~我们会及时处理!
点击此处反馈
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论7