PHP 编码规范-注释

欢迎您访问我爱IT技术网，今天小编为你分享的编程技术是：【PHP 编码规范-注释】，下面是详细的分享！

PHP 编码规范-注释

4.1 块注释

块注释通常用于提供对文件，方法，数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方，比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。

块注释之首应该有一个空行，用于把块注释和代码分割开来，比如：

块注释可以以

注意：如果你不使用indent(1)，就不必在代码中使用
　　...
}

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格。

若你想给出有关类、变量或方法的信息，而这些信息又不适合写在文档中，则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如，有关一个类实现的细节，应放入紧跟在类声明后面的实现块注释中，而不是放在文档注释中。

文档注释不能放在一个方法或构造器的定义块中，因为程序会将位于文档注释之后的第一个声明与其相关联。

以上所分享的是关于PHP 编码规范-注释，下面是编辑为你推荐的有价值的用户互动：

　　相关问题：《PHP程序编码规范标准》txt全集下载

　　答：PHP程序编码规范标准 txt全集小说附件已上传到百度网盘，点击免费下载： 应该是全本了 >>详细

　　相关问题：phpstorm 怎么设置编码规范

　　答：右下角有字符编码，直接点击切换就可以 >>详细

　　相关问题：php面向对象编程书写代码规范

　　答：类命名 a) 使用大写字母作为词的分隔，其他的字母均使用小写，即驼峰格式。 b) 名字的首字母使用大写 c) 不要使用下划线(’_') d) interface接口最好使用大写字母I,并以Interface结尾 例如： class NameOneTwo class Name interface IExampleInte... >>详细