php

PHP 注释规范

dafenqi
2023-08-04 / 0 评论 / 17 阅读 / 正在检测是否收录...

PHP 注释规范

文件注释 :

文件注释置于文件开头用于描述文件的作用与版本信息

 

/**

* simple description(必须)

*

* more description.......(必须)

*

* @package user (必须)

* @author yurong (必须)

* @version user.php add by yurong 2011-07-27 16:48 (必须)

* @version user.php modify by yurong 2011-07-27 17:48

*/

类注释:

类注释置于类开头,主要描述类的作用, 必要时要加实例说明

/**

* Enter description here... (必须)

*

* [example]

* $user = new User ();

* $user->init();

* $userInfo = $user->getUserInfoByUid($uid); *

* [/example]

*

*/

class User{

}

函数及方法注释:

函数及方法注释置于函数或方法开头,主要描述函数或方法的作用,及参数说明,必要时要加使用说明

/**

* Enter description here... (必须)

*

* @param int $uid //用户uid (必须)

* @return bool (必须)

* [example]

* $user = new User ();

* $user->init();

* $userInfo = $user->getUserInfoByUid($uid); *

* [/example]

*

*/

function getUserInfoByUid($uid){

return false;

}

块注释:

块注释通常用于提供对一大段数据结构和算法的功能代码的描述。

//=====================================

// description…

//

//=====================================

If(true){ //condition1……..

………….

}else{ //condition1……..

………..

}

变量注释:

描述变量信息,与变量申明置于同一行,注释尽可能的对齐

Public $username; //用户uid

Public $tel; //用户电话

引入文件注释:

描述引入文件的功能与含义

//模块配置信息, 包含必须的模块配置信息

Include(SERVER_ROOT.’/config/compontentConfig.php’);

【注:注释应该详细表述程序所实现的功能,而非语言翻译】

附:

文档标记说明:
@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
该标记用于解析一段文件内容,并将他们高亮显示。Phpdoc会试图从该标记给的文件路径中读取文件内容
@const
使用范围:define
用来指明php中define的常量
@final
使用范围:class,function,var
指明关键字是一个最终的类、方法、属性,禁止派生、修改。
@filesource
和example类似,只不过该标记将直接读取当前解析的php文件的内容并显示。
@global
指明在此函数中引用的全局变量
@ingore
用于在文档中忽略指定的关键字
@license
相当于html标签中的<a>,首先是URL,接着是要显示的内容
例如<a href=”http://www.baidu.com”>百度</a>
可以写作 @license http://www.baidu.com 百度
@link
类似于license
但还可以通过link指到文档中的任何一个关键字
@name
为关键字指定一个别名。
@package
使用范围:页面级别的-> define,function,include
类级别的->class,var,methods
用于逻辑上将一个或几个关键字分到一组。
@abstrcut
说明当前类是一个抽象类
@param
指明一个函数的参数
@return
指明一个方法或函数的返回指
@static
指明关建字是静态的。
@var
指明变量类型
@version
指明版本信息
@todo
指明应该改进或没有实现的地方
@throws
指明此函数可能抛出的错误异常,极其发生的情况
上面提到过,普通的文档标记标记必须在每行的开头以@标记,除此之外,还有一种标记叫做inline tag,用{@}表示,具体包括以下几种:
{@link}
用法同@link
{@source}
显示一段函数或方法的内容
0

Deprecated: strtolower(): Passing null to parameter #1 ($string) of type string is deprecated in /www/wwwroot/testblog.58heshihu.com/var/Widget/Archive.php on line 1032

评论 (0)

取消