分析PHP编码规范之注释和文件结构

发布时间：2022-03-30 13:14 所属栏目：121 来源：互联网

导读：images存放图片文件，include中是系统是要引用的文件，一般在parameter中存放参数文件，config中存放配置文件，function中存放方法文件，如javascript的方法等，并按功能模块的分类，将各功能的类也放入其中文件名文件夹命名一般采用英文，长度一般不超过2

　　images存放图片文件，include中是系统是要引用的文件，一般在parameter中存放参数文件，config中存放配置文件，function中存放方法文件，如javascript的方法等，并按功能模块的分类，将各功能的类也放入其中

　　文件名

　　文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。除特殊情况才使用中文拼音，一些常见的文件夹命名如：images(存放图形文件)，flash(存放Flash文件)，style(存放CSS文件)，scripts(存放Javascript脚本)，inc(存放include文件)，link(存放友情链接),media(存放多媒体文件)等。文件名称统一用小写的英文字母、数字和下划线的组合。

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

　　/*

　　* 这里是块注释

　　*/

　　块注释可以以/*-开头，这样indent(1)就可以将之识别为一个代码块的开始，而不会重排它。

　　/*-

　　* 如果想被忽略，可是使用特别格式的块注释

　　*

　　* one

　　* 　　two

　　* 　　　　three

　　*/

　　注意：如果你不使用indent(1)，就不必在代码中使用/*-，或为他人可能对你的代码运行indent(1)作让步。

　　单行注释

　　短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完，就该采用块注释。单行注释之前应该有一个空行。以下是一个代码中单行注释的例子：

　　if (condition) {

　　/* 以下代码运行的条件 */

　　...

　　}

　　尾端注释

　　极短的注释可以与它们所要描述的代码位于同一行，但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中，它们应该具有相同的缩进。

　　以下是一个代码中尾端注释的例子：

　　if ($a == 2) {

　　return TRUE; /* 对单一条件的说明 */

　　} else {

　　return isPrime($a); /* 其余的条件 */

　　}

　　行末注释

　　注释界定符"//"，可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本;然而，它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子：

　　if ($foo > 1) {

　　// 第二种用法.

　　...

　　}

　　else {

　　return false; // 说明返回值的原因

　　}

　　//if ($bar > 1) {

　　//

　　// 　// 第三种用法

　　//　 ...

　　//}

　　//else {

　　// return false;

　　//}

　　文档注释

　　文档注释描述php的类、构造器，方法，以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中，一个注释对应一个类或成员。该注释应位于声明之前：

　　/**

　　* 说明这个类的一些 ...

　　*/

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

（编辑：ASP站长网）