PHP注释规范、方法和作用

PHP 注释 (Comments) 有两种类型:

一种是单行注释,一种是多行注释。

PHP 单行注释语法

在一行中所有 "//" 符号右面的文本都被视为注释, 因为 PHP 解析器忽略该行 "//" 右面的所有内容。 示例如下: 也可以一行只写注释,不写代码,如下:

PHP 多行注释语法

PHP 多行注释以 "/*" 开头,以 "*/" 结束。在 "/*" 和 "*/" 之间,可以写多行注释。 示例如下,红色部分就是多行注释的内容。

4.1 块注释

块注释通常用于提供对文件,方法,数据结构和算法的描述。 块注释被置于每个文件的开始处以及每个方法之前;它们也可以被用于其他地方,比如方法内部。 在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。 块注释之首应该有一个空行,用于把块注释和代码分割开来,比如: /* * 这里是块注释 */ 块注释可以以/*-开头,这样indent(C语言格式化代码)就可以将之识别为一个代码块的开始,而不会重排它。 /*- * 如果想被忽略,可是使用特别格式的块注释 * * one *   two *     three */ 注意:如果你不使用indent(C语言格式化代码),就不必在代码中使用/*-,或为他人可能对你的代码运行indent(C语言格式化代码)作让步。

4.2 单行注释

短注释可以显示在一行内,并与其后的代码具有一样的缩进层级。 如果一个注释不能在一行内写完,就该采用块注释。 单行注释之前应该有一个空行。   以下是一个代码中单行注释的例子: if (condition) { /* 以下代码运行的条件 */ ... }

4.3 尾端注释

极短的注释可以与它们所要描述的代码位于同一行,但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中,它们应该具有相同的缩进。 以下是一个代码中尾端注释的例子: if ($a == 2) { return TRUE; /* 对单一条件的说明 */ } else { return isPrime($a); /* 其余的条件 */ }

4.4 行末注释

注释界定符"//",可以注释掉整行或者一行中的一部分。 它一般不用于连续多行的注释文本;然而,它可以用来注释掉连续多行的代码段。   以下是所有三种风格的例子: if ($foo > 1) { // 第二种用法. ... } else { return false; // 说明返回值的原因 } //if ($bar > 1) { // //  // 第三种用法 //  ... //} //else { // return false; //}

4.5 文档注释

文档注释描述php的类、构造器,方法,以及字段(field) 。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类或成员。   该注释应位于声明之前: /** * 说明这个类的一些 ... */ class Example { ... 注意顶层(top-level)的类是不缩进的,而其成员是缩进的。描述类的文档注释的第一行(/**)不需缩进;随后的文档注释每行都缩进1格(使星号纵向对齐)。成员,包括构造函数在内,其文档注释的第一行缩进4格,随后每行都缩进5格。 若你想给出有关类、变量或方法的信息,而这些信息又不适合写在文档中,则可使用实现块注释或紧跟在声明后面的单行注释。例如,有关一个类实现的细节,应放入紧跟在类声明后面的实现块注释中,而不是放在文档注释中。 文档注释不能放在一个方法或构造器的定义块中,因为程序会将位于文档注释之后的第一个声明与其相关联。

PHP注释的基本作用:

1.文件头的注释,介绍文件名,功能以及作者版本号等信息

/** *文件名简单介绍 * *文件功能。 * @author alvin 作者 * @version 1.0 版本号 */

2.函数的注释,函数作用,参数介绍及返回类型

/**

* 函数的含义说明

*

* @access public

* @param mixed $arg1 参数一的说明

* @param mixed $arg2 参数二的说明

* @param mixed $mixed 这是一个混合类型

* @return array 返回类型

*/

3.类的注释,类名及介绍

/**

* 类的介绍

*

* 类的详细介绍(可选。)。

* @author      alvin 作者

* @version    1.0 版本号

*/

4.多行注释

/* php注释语法

这是多行注释。*/

5.单行注释

$n = 10; //数量n,这是单行注释

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

推荐阅读更多精彩内容