[LNMP]php程序注释建议规范和工具

说明


本注释建议适用于php程序开发,包括基于Yii框架的php开发,不局限于本规范所列出的注释参数,但至少遵循phpDoc的标准进行注释。

类文件注释


适用于自定义的类文件或其他php文件的注释,放在文件的头部
<pre>
/**
* 描述你的类或文件的作用
*
* @package 所属的模块名或函数组名,例如:本类文件是Gather模块的其中一个数据处理类,那填上Gather
* @author 你的名字简称或账户名
* @copyright XXX Inc
* @version 本文件的版本号,例如:1.0
*/

class DataHandleForGather{
//code
}
</pre>

类:属性注释

适用于类属性或常量定义的注释
<pre>
/**
* 属性说明
*
* @var 属性的数据类型,例如:String,Array
*/
public $currentStringEncoding = "";
</pre>

类:方法注释

<pre>
/**
* 本方法的描述
* @param 参数类型 参数名,例如:String $currentStringEncoding
* @return 返回值的类型,例如:boolean,string,array
*/
public function isUtf8String($currentStringEncoding){
//code
}
</pre>

类注释范例

DataHandleForGather.php
<pre>
/**
* 描述你的类或文件的作用
*
* @package 所属的模块名或函数组名,例如:本类文件是Gather模块的其中一个数据处理类,那填上Gather
* @author 你的名字简称或账户名
* @copyright Dayoo Rnd
* @version 本文件的版本号,例如:1.0
*/
class DataHandleForGather{
/**
* 属性说明
*
* @var 属性的数据类型,例如:String,Array
*/
public $currentStringEncoding;

/**
* 本方法的描述
* @param 参数类型 参数名,例如:String $currentStringEncoding
* @return 返回值的类型,例如:boolean,string,array
*/
public function isUtf8String($currentStringEncoding){
//code
}
...
}
</pre>

phpDoc注释标准


phpDoc的官方标准

phpDoc

注释辅助工具:DocBlockr


适用于sublime:DocBlockr,可以提高注释的效率,并且格式统一。

整理于2014/11

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,458评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,454评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,171评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,062评论 0 207
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,440评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,661评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,906评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,609评论 0 200
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,379评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,600评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,085评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,409评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,072评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,088评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,860评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,704评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,608评论 2 270

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 170,569评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,100评论 18 139
  • date: 2017-11-21 18:15:18title: yii 源码解读 百度脑图 - yii 源码解析:...
    daydaygo阅读 3,416评论 1 11
  • 露株 在叶梢上 等风 等风 那是多情的季节 无须请柬 风,也会来 激情过后 约定 下次再见 风来了 你却不在 就连...
    挑夫阅读 368评论 11 17
  • 一、文件/文件夹管理 ls 列出当前目录文件(不包括隐含文件)ls -a 列出当前目录文件(包括隐含文件)l...
    路痴千行阅读 2,325评论 0 5