PHP Document 代码注释规范
核心提示:PHPDocumentor是1个用PHP写的工具,对有规范注释的php程序,它能够快速天生具有相互参照,索引等功能的API文档。老的版本是 phpdoc。
PHPDocumentor是1个用PHP写的工具,对有规范注释的php程序,它能够快速天生具有相互参照,索引等功能的API文档。老的版本是 phpdoc。
1. 甚么是phpDocumentor ?
PHPDocumentor是1个用PHP写的工具,对有规范注释的php程序,它能够快速天生具有相互参照,索引等功能的API文档。老的版本是 phpdoc,从1.3.0开始,更名为phpDocumentor,新的版本加上了对php5语法的支持,同时,可以通过在客户端浏览器上操纵天生文档,文档可以转换为PDF,HTML,CHM几种情势,非常的方便。
PHPDocumentor工作时,会扫描指定目录下面的php源代码,扫描其中的关键字,截取需要分析的注释,然后分析注释中的专用的tag,天生 xml文件,接着根据已分析完的类和模块的信息,建立相应的索引,天生xml文件,对天生的xml文件,使用定制的模板输出为指定格式的文件。
2. 安装phpDocumentor
和其他pear下的模块1样,phpDocumentor的安装也分为自动安装和手动安装两种方式,两种方式都非常方便:
a. 通过pear 自动安装
在命令行下输进
pear install PhpDocumentor
b. 手动安装
在http://manual.phpdoc.org/下载最新版本的PhpDocumentor(现在是1.4.0),把内容解压即可。
3.怎样使用PhpDocumentor天生文档
命令行方式:
在phpDocumentor所在目录下,输进
Php –h
会得到1个具体的参数表,其中几个重要的参数以下:
-f 要进行分析的文件名,多个文件用逗号隔开
-d 要分析的目录,多个目录用逗号分割
-t 天生的文档的寄存路径
-o 输出的文档格式,结构为输出格式:转换器名:模板目录。
例如:phpdoc -o HTML:frames:earthli -f test.php -t docs
Web界面天生
在新的phpdoc中,除在命令行下天生文档外,还可以在客户端浏览器上操纵天生文档,具体方法是先把PhpDocumentor的内容放在apache目录下使得通过浏览器可以访问到,访问后显示以下的界面:
点击files按钮,选择要处理的php文件或文件夹,还可以通过该指定该界面下的Files to ignore来忽视对某些文件的处理。
然后点击output按钮来选择天生文档的寄存路径和格式.
最后点击create,phpdocumentor就会自动开始天生文档了,最下方会显示天生的进度及状态,假设成功,会显示
Total Documentation Time: 1 seconds
done
Operation Completed!!
然后,我们便可以够通过查看天生的文档了,假设是pdf格式的,名字默以为documentation.pdf。
4.给php代码添加规范的注释
PHPDocument是从你的源代码的注释中天生文档,因此在给你的程序做注释的进程,也就是你编制文档的进程。
从这1点上讲,PHPdoc促使你要养成良好的编程习惯,尽可能使用规范,清楚文字为你的程序做注释,同时多多少少也避免了事后编制文档和文档的更新不同步的1些题目。
在phpdocumentor中,注释分为文档性注释和非文档性注释。
所谓文档性注释,是那些放在特定关键字前面的多行注释,特定关键字是指能够被phpdoc分析的关键字,例如class,var等,具体的可参加附录1.
那些没有在关键字前面或不规范的注释就称作非文档性注释,这些注释将不会被phpdoc所分析,也不会出现在你产生的api文当中。
3.2如何书写文档性注释:
所有的文档性注释都是由/**开始的1个多行注释,在phpDocumentor里称为DocBlock, DocBlock是指软件开发职员编写的关于某个关键字的帮助信息,使得其他人能够通过它知道这个关键字的具体用处,如何使用。 PhpDocumentor规定1个DocBlock包括以下信息:
1. 功能简述区
2. 具体说明区
3. 标记tag
文档性注释的第1行是功能描写区,正文1般是简明扼要地说明这个类,方法或函数的功能,功能简述的正文在天生的文档中将显示在索引区。功能描写区的内容可以通过1个空行或 . 来结束
在功能描写区后是1个空行,接着是具体说明区,. 这部份主要是具体说明你的API的功能,用处,假设可能,也能够有用法举例等等。在这部份,你应当侧重阐明你的API函数或方法的通常的用处,用法,并且指明是否是是跨平台的(假设触及到),对和平台相干的信息,你要和那些通用的信息辨别对待,通常的做法是另起1行,然后写出在某个特定平台上的留意事项或是特别的信息,这些信息应当足够,以便你的读者能够编写相应的测试信息,比如边界条件,参数范围,断点等等。
以后一样是1个空缺行,然后是文档的标记tag,指明1些技术上的信息,主要是最主要的是调用参数类型,返回值极其类型,继续关系,相干方法/函数等等。
关于文档标记,具体的请参考第4节:文档标记。
文档注释中还可使用例如 这样的标签,具体先容请参考附录2。
下面是1个文档注释的例子
以下为援用的内容:
/** * 函数add,实现两个数的加法 * * 1个简单的加法计算,函数接受两个数a、b,返回他们的和c * * @param int 加数 * @param int 被加数 * @return integer */ function Add($a, $b) { return $a+$b; }
天生文档以下: Add integer Add( int $a, int $b) [line 45] 函数add,实现两个数的加法 Constants 1个简单的加法计算,函数接受两个数a、b,返回他们的和c Parameters ? int $a - 加数 ? int $b - 被加数 5.文档标记: 文档标记的使用范围是指该标记可以用来修饰的关键字,或其他文档标记。 所有的文档标记都是在每1行的 * 后面以@开头。假设在1段话的中间出来@的标记,这个标记将会被当作普通内容而被忽视掉。 @access 使用范围:class,function,var,define,module 该标记用于指明关键字的存取权限:private、public或proteced @author 指明作者 @copyright 使用范围:class,function,var,define,module,use 指明版权信息 @deprecated 使用范围:class,function,var,define,module,constent,global,include 指明不用或废弃的关键字 @example 该标记用于解析1段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容 @const 使用范围:define 用来指明php中define的常量 @final 使用范围:class,function,var 指明关键字是1个终极的类、方法、属性,制止派生、修改。 @filesource 和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。 @global 指明在此函数中援用的全局变量 @ingore 用于在文档中忽视指定的关键字 @license 相当于html标签中的,首先是URL,接着是要显示的内容 例如百度 可以写作 @license http://www.baidu.com 百度 @link 类似于license 但还可以通过link指到文档中的任何1个关键字 @name 为关键字指定1个别名。 @package 使用范围:页面级别的-> define,function,include 类级别的->class,var,methods 用于逻辑上将1个或几个关键字分到1组。 @abstrcut 说明当前类是1个抽象类 @param 指明1个函数的参数 @return 指明1个方法或函数的返回指 @static 指明关建字是静态的。 @var 指明变量类型 @version 指明版本信息 @todo 指明应当改进或没有实现的地方 @throws 指明此函数可能抛出的毛病异常,极其产生的情况 上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有1种标记叫做inline tag,用{@}表示,具体包括以下几种: {@link} 用法同@link {@source} 显示1段函数或方法的内容 6.1些注释规范 a.注释必须是 /** * XXXXXXX */ 的情势 b.对援用了全局变量的函数,必须使用glboal标记。 c.对变量,必须用var标记其类型(int,string,bool...) d.函数必须通过param和return标记指明其参数和返回值 e.对出现两次或两次以上的关键字,要通过ingore忽视掉过剩的,只保存1个即可 f.调用了其他函数或类的地方,要使用link或其他标记链接到相应的部份,便于文档的浏览。 g.必要的地方使用非文档性注释,进步代码易读性。 h.描写性内容尽可能简明扼要,尽可能使用短语而非句子。 i.全局变量,静态变量和常量必须用相应标记说明 7. 总结 phpDocumentor是1个非常强大的文档自动天生工具,利用它可以帮助我们编写规范的注释,天生易于理解,结构清楚的文档,对我们的代码升级,保护,移交等都有非常大的帮助。 关于phpDocumentor更加具体的说明,可以到它的官方网站 http://manual.phpdoc.org/查阅 8.附录 附录1: 能够被phpdoc辨认的关键字: Include Require include_once require_once define function global class 附录2 文档中可使用的标签
|
1
2
下1页
核心提示:PHPDocumentor是1个用PHP写的工具,对有规范注释的php程序,它能够快速天生具有相互参照,索引等功能的API文档。老的版本是 phpdoc。
附录3:
1段含有规范注释的php代码 :
以下为援用的内容:
/** * Sample File 2, phpDocumentor Quickstart * * This file demonstrates the rich information that can be included in * in-code documentation through DocBlocks and tags. * @author Greg Beaver * @version 1.0 * @package sample */ // sample file #1 /** * Dummy include value, to demonstrate the parsing power of phpDocumentor */ include_once 'sample3.php'; /** * Special global variable declaration DocBlock * @global integer $GLOBALS['_myvar'] * @name $_myvar */ $GLOBALS['_myvar'] = 6; /** * Constants */ /** * first constant */ define('testing', 6); /** * second constant */ define('anotherconstant', strlen('hello')); /** * A sample function docblock * @global string document the fact that this function uses $_myvar * @staticvar integer $staticvar this is actually what is returned * @param string $param1 name to declare * @param string $param2 value of the name * @return integer */ function firstFunc($param1, $param2 = 'optional') { static $staticvar = 7; global $_myvar; return $staticvar; } /** * The first example class, this is in the same package as the * procedural stuff in the start of the file * @package sample * @subpackage classes */ class myclass { /** * A sample private variable, this can be hidden with the --parseprivate * option * @accessprivate * @var integer|string */ var $firstvar = 6; /** * @link http://www.example.com Example link * @see myclass() * @uses testing, anotherconstant * @var array */ var $secondvar = array( 'stuff' => array( 6, 17, 'armadillo' ), testing => anotherconstant ); /** * Constructor sets up {@link $firstvar} */ function myclass() { $this->firstvar = 7; } /** * Return a thingie based on $paramie * @param boolean $paramie * @return integer|babyclass */ function parentfunc($paramie) { if ($paramie) { return 6; } else { return new babyclass; } } } /** * @package sample1 */ class babyclass extends myclass { /** * The answer to Life, the Universe and Everything * @var integer */ var $secondvar = 42; /** * Configuration values * @var array */ var $thirdvar; /** * Calls parent constructor, then increments {@link $firstvar} */ function babyclass() { parent::myclass(); $this->firstvar++; } /** * This always returns a myclass * @param ignored $paramie * @return myclass */ function parentfunc($paramie) { return new myclass; } } ?>
|
上1页
1
2
http://www.fw8.net/TAG:
函数,
文档,
关键字,
标记,
注释