php DOC的用法

yangl20062015年09月05日 23:13 分类 : PHP  > PHP应用
阅读: 1087

分享到微信朋友圈

我们开发的所有类都会使用PHPDoc风格的注释,这样就能很容易地为所有类构建API文档。PHPDoc建立在Sun公司的Javadoc系统基础之上,这是一种为所有函数、参数、变量和包加注释的简单方法,以便于开发人员轻松地重用这些函数、参数、变量和包。

我们开发的所有类都会使用PHPDoc风格的注释,这样就能很容易地为所有类构建API文档。PHPDoc建立在Sun公司的Javadoc系统基础之上,这是一种为所有函数、参数、变量和包加注释的简单方法,以便于开发人员轻松地重用这些函数、参数、变量和包。

尽管这一点对于这个Web应用的开发并不太重要,但开发过程中使用这种风格的注释是一个好习惯。另外,查看本书中的代码示例时你会发现,每个函数前面有一个PHPDoc注释块确实很有用。

php DOC的用法

@name 名字

@abstract 申明变量/类/方法
@access 指明这个变量、类、函数/方法的存取权限
@author 函数作者的名字和邮箱地址
@category  组织packages
@copyright 指明版权信息
@const 指明常量
@deprecate 指明不推荐或者是废弃的信息
@example 示例
@exclude 指明当前的注释将不进行分析,不出现在文挡中
@final 指明这是一个最终的类、方法、属性,禁止派生、修改。
@global 指明在此函数中引用的全局变量
@include 指明包含的文件的信息
@link 定义在线连接
@module 定义归属的模块信息
@modulegroup 定义归属的模块组
@package 定义归属的包的信息
@param 定义函数或者方法的参数信息
@return 定义函数或者方法的返回信息
@see 定义需要参考的函数、变量,并加入相应的超级连接。
@since 指明该api函数或者方法是从哪个版本开始引入的
@static 指明变量、类、函数是静态的。
@throws 指明此函数可能抛出的错误异常,极其发生的情况
@todo 指明应该改进或没有实现的地方
@var 定义说明变量/属性。
@version 定义版本信息

yangl2006
yangl2006

精彩评论:0

还可以输入250个字 评论

评论成功

评论失败

 

微信公众号

微博