PHPDocument 代码注释规范1. 安装phpDocumentor（不推荐命令行安装）在http://manual.phpdoc.org/下载最新版本的PhpDoc放在web服务器目录下使得通过浏览器可以访问到点击files按钮，选择要处理的php文件或文件夹还可以通过该指定该界面下的Files to ignore来忽略对某些文件的处理。然后点击output按钮来选择生成文档的存放路径和格式.最后点击create，phpdocumentor就会自动开始生成文档了。2．如何写PHP规范注释所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记，这个标记将会被当做普通内容而被忽略掉。@access&&& &&& 该标记用于指明关键字的存取权限：private、public或proteced 使用范围：class,function,var,define,module@author&&& &&& 指明作者@copyright&&& 指明版权信息@const&&& &&& 使用范围：define 用来指明php中define的常量@final&&& &&& &&& 使用范围：class,function,var 指明关键字是一个最终的类、方法、属性，禁止派生、修改。@global&&& &&& 指明在此函数中引用的全局变量@name&&& &&& &&& 为关键字指定一个别名。@package&&& 用于逻辑上将一个或几个关键字分到一组。@abstrcut&&& 说明当前类是一个抽象类@param&&& &&& 指明一个函数的参数@return&&& &&& 指明一个方法或函数的返回值@static&&& &&& &&& 指明关建字是静态的。@var&&& &&& &&& 指明变量类型@version&&& &&& 指明版本信息@todo&&& &&& &&& 指明应该改进或没有实现的地方@link&&& &&& &&& 可以通过link指到文档中的任何一个关键字@ingore&&& &&& 用于在文档中忽略指定的关键字一些注释规范a.注释必须是/*** XXXXXXX*/的形式b.对于引用了全局变量的函数，必须使用glboal标记。c.对于变量，必须用var标记其类型（int,string,bool...）d.函数必须通过param和return标记指明其参数和返回值e.对于出现两次或两次以上的关键字，要通过ingore忽略掉多余的，只保留一个即可f.调用了其他函数或类的地方，要使用link或其他标记链接到相应的部分，便于文档的阅读。g.必要的地方使用非文档性注释（PHPDOC无法识别的关键字前的注释），提高代码易读性。h.描述性内容尽量简明扼要，尽可能使用短语而非句子。i.全局变量，静态变量和常量必须用相应标记说明能够被phpdoc识别的关键字：IncludeRequireinclude_oncerequire_oncedefinefunctionglobalclass3. 规范注释的php代码 :&?php/*** 文件名(sample2.php)** 功能描述（略）** @author steve &&* @version 1.0* @package sample2*//*** 包含文件*/include_once 'sample3.php';/*** 声明全局变量* @global integer $GLOBALS['_myvar']* @name $_myvar*/$GLOBALS['_myvar'] = 6;/*** 声明全局常量*/define('NUM', 6);/*** 类名** 类功能描述** @package sample2* @subpackage classes(如果是父类 就添加)*/class myclass {/*** 声明普通变量** @accessprivate* @var integer|string*/var $firstvar = 6;/*** 创建构造函数 {@link $firstvar}*/function myclass() {$this-&firstvar = 7;}/*** 定义函数** 函数功能描述** @global string $_myvar* @staticvar integer $staticvar* @param string $param1* @param string $param2* @return integer|string*/function firstFunc($param1, $param2 = 'optional') {static $staticvar = 7;global $_return $}}?&
阅读(...) 评论()给php代码添加规范的注释更多参考&在phpdocumentor中，注释分为文档性注释和非文档性注释。所谓文档性注释，是那些放在特定关键字前面的多行注释，特定关键字是指能够被phpdoc分析的关键字，例如class，var等，具体的可参加附录1.那些没有在关键字前面或者不规范的注释就称作非文档性注释，这些注释将不会被phpdoc所分析，也不会出现在你产生的api文当中。3.2如何书写文档性注释:所 有的文档性注释都是由/**开始的一个多行注释，在phpDocumentor里称为DocBlock, DocBlock是指软件开发人员编写的关于某个关键字的帮助信息，使得其他人能够通过它知道这个关键字的具体用途，如何使用。 PhpDocumentor规定一个DocBlock包含如下信息：1. 功能简述区2. 详细说明区3. 标记tag文档性注释的第一行是功能描述区，正文一般是简明扼要地说明这个类，方法或者的功能，功能简述的正文在生成的文档中将显示在索引区。功能描述区的内容可以通过一个空行或者 . 来结束在 功能描述区后是一个空行，接着是详细说明区,. 这部分主要是详细说明你的API的功能，用途，如果可能，也可以有用法举例等等。在这部分，你应该着重阐明你的API函数或者方法的通常的用途，用法，并 且指明是否是跨平台的（如果涉及到），对于和平台相关的信息，你要和那些通用的信息区别对待，通常的做法是另起一行，然后写出在某个特定平台上的注意事项 或者是特别的信息，这些信息应该足够，以便你的读者能够编写相应的测试信息，比如边界条件，参数范围，断点等等。之后同样是一个空白行，然后是文档的标记tag，指明一些上的信息，主要是最主要的是调用参数类型，返回值极其类型，继承关系，相关方法/函数等等。文档注释中还可以使用例如&b& &code&这样的标签
5．文档标记：文档标记的使用范围是指该标记可以用来修饰的关键字，或其他文档标记。所有的文档标记都是在每一行的 * 后面以@开头。如果在一段话的中间出来@的标记，这个标记将会被当做普通内容而被忽略掉。
6．一些注释规范a.注释必须是/*** XXXXXXX*/的形式b.对于引用了全局变量的函数，必须使用glboal标记。c.对于变量，必须用var标记其类型（int,string,bool...）d.函数必须通过param和return标记指明其参数和返回值e.对于出现两次或两次以上的关键字，要通过ingore忽略掉多余的，只保留一个即可f.调用了其他函数或类的地方，要使用link或其他标记链接到相应的部分，便于文档的阅读。g.必要的地方使用非文档性注释，提高代码易读性。h.描述性内容尽量简明扼要，尽可能使用短语而非句子。i.全局变量，静态变量和常量必须用相应标记说明
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category
组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息MyEclipse编码设置
* @example 示例
* @exclude 指明当前的注释将不进行分析，不出现在文挡中
* @final 指明这是一个最终的类、方法、属性，禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量，并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
function XXX($a){..}
* 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
//PHP code
* 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;
阅读(...) 评论()欢迎访问蓝队云一站式平台！
关注蓝队云
您的位置：
php语言注释，单行注释和多行注释
发布时间：&&&&&浏览量：1234人
上一篇：下一篇：
最新发布的内容
大家感兴趣的内容
服务时间：9:00 - 24:00
选择对应客服在线沟通：
您可能遇到了下面的问题：
400专线7x24小时全时响应
技术在线支持
服务时间：全天24小时
选择对应技术在线沟通：
您可能遇到了下面的问题：
400专线7x24小时全时响应
网站ICP备案咨询
服务时间：9:00 - 17:30
选择对应客服在线沟通：
您可能遇到了下面的问题：
400专线7x24小时全时响应echo&"This&is&a&test";&//&This&is&a&one-line&c++&style&comment&&&&/*&This&is&a&multi&line&comment&&&&&&&yet&another&line&of&comment&*/&&&&echo&"This&is&yet&another&test";&&&&echo&'One&Final&Test';&#&This&is&a&one-line&shell-style&comment?&
单行注释仅仅注释到行末或者当前的 PHP 代码块，视乎哪个首先出现。这意味着在
// ... ?& 或者 # ...
之后的 HTML 代码将被显示出来：?&
跳出了 PHP 模式并返回了 HTML 模式，// 或 #
并不能影响到这一点。如果启用了
asp_tags 配置选项，其行为和
// %& 或 # %&
相同。不过，&/script&
标记在单行注释中不会跳出 PHP 模式。
#&echo&"simple";?&&example.&/h1&&p&The&header&above&will&say&'This&is&an&example'.
C 风格的注释在碰到第一个 */
时结束。要确保不要嵌套 C 风格的注释。试图注释掉一大块代码时很容易出现该错误。
/*&&&&echo&"This&is&a&test";&/*&This&comment&will&cause&a&problem&*/&*/?&php语言注释，单行注释及多行注释
语言注释分为单行注释和多行注释。
1. PHP单行注释：
PHP注释符号：//
PHP单行注释示例：
//输出 脚本之家
echo 脚本之家&;
2. PHP多行注释
PHP多行注释符号：/* */
PHP多行注释示例：
/*输出 脚本之家
脚本之家是国内专业的网站建设资源、脚本学习类网站，提供、php、asp.net、javascript、jquery、vbscript、批处理、网页制作、网络编程、网站建设等编程资料。