浅谈php开发中编码规范之一

首页> 编程小贴士> 查看全部 >12-28

1 文件结构


|――images

|――include

  |――parameter

  |――config

  |――function

|――index


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



2 文件名


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



3 源文件的编码规范

3.1 开头注释


所有的源文件都应该在开头有一个C语言风格的注释,其中列出类名、功能、版本信息、日期、作者和版权声明:



/*

 * 类名

 * 功能

 * 版本

 * 日期

 * 作者

 * 版权

 */


如果对文件进行了修改,应该在文件头中说明修改目的、修改日期、修改人,并变更文件的版本信息;如果修改问文件的一部分,则在文件中进行注释即可,并且标识出修改部分的起止位置


……


/*

 * 修改目的

 * 修改日期

 * 修改人

 * 版本

 */


……


修改起始


……


……


修改结束


……


3.2 引入语句


引入语句应该位于文件的头部,并在引入时说明引入文件的作用。例如:


//数据库操作类

require( “db.php” );



3.3 类的声明


1 类文档注释(/**……*/) 该注释中所需包含的信息,参见"文档注释" 

2 类的声明

3 类实现的注释(/*……*/)如果有必要的话 该注释应包含任何有关整个类的信息,而这些信息又不适合作为类文档注释。

4 类的(静态)变量 首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。

5 实例变量 首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。 

6 构造器 

7 方法 这些方法应该按功能,而非作用域或访问权限,分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码


3.4 缩进排版


4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个),所以在某些编辑器中,需要特别指定一下制表符的长度为4(UltraEdit),而在某些编辑器中,会将制表符转换为空格



3.5 行长度


尽量避免一行的长度超过80个字符,因为很多终端和工具不能很好处理之。



3.6 换行


当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:


- 在一个逗号后面断开

- 在一个操作符前面断开

- 宁可选择较高级别(higher-level)的断开,而非较低级别(lower-level)的断开

- 新的一行应该与上一行同一级别表达式的开头处对齐

- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边,那就代之以缩进8个空格。 


以下是断开方法调用的一些例子:



someMethod(longExpression1, longExpression2, longExpression3, 

             longExpression4, longExpression5);


$var = someMethod1(longExpression1, 

                 someMethod2(longExpression2, 

                              longExpression3));



以下是两个断开算术表达式的例子。前者更好,因为断开处位于括号表达式的外边,这是个较高级别的断开。



$longName1 = $longName2 * ($longName3 + $longName4 - $longName5)

            + 4 * $longname6; //使用这种缩进方式


$longName1 = $longName2 * ($longName3 + $longName4 

                   - $longName5) + 4 * $longname6; //避免这种



以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和第三行移得很靠右,所以代之以缩进8个空格



//传统的缩进方式

function someMethod($anArg, $anotherArg, $yetAnotherArg, 

          $andStillAnother) {

...

}


//利用8个连续空格避免过渡的缩进

function horkingLongMethodName($anArg,

     $anotherArg, $yetAnotherArg,

     $andStillAnother) {

...

}



if语句的换行通常使用8个空格的规则,因为常规缩进(4个空格)会使语句体看起来比较费劲。比如:



//不要使用这种缩进方式

if ((condition1 && condition2)

  || (condition3 && condition4)

  ||!(condition5 && condition6)) { //错误的换行方式,没有进行缩进

  doSomethingAboutIt(); //条件与此句对齐,造成阅读程序时很可能漏过此句

}


//应该使用这种缩进方式

if ((condition1 && condition2)

    || (condition3 && condition4)

    ||!(condition5 && condition6)) {

  doSomethingAboutIt();

}


//或者这样的缩进方式也可以

if ((condition1 && condition2) || (condition3 && condition4)

        ||!(condition5 && condition6)) {

  doSomethingAboutIt();

}



这里有三种可行的方法用于处理三元运算表达式:


$alpha = (aLongBooleanExpression) ? beta : gamma;


$alpha = (aLongBooleanExpression) ? beta

                 : gamma;


$alpha = (aLongBooleanExpression)

    ? beta

    : gamma;





4 注释

4.1 块注释


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


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



/*

 * 这里是块注释

*/



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



/*-

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

 * 

 * one

 *   two

 *     three

 */



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



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


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


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


中国 · 云南 · 昆明

然成科技微信二维码
扫一扫关注然成微信

办公室:云南省昆明市盘龙区白云路北京路花苑3幢403(地铁2号线白云路站)

Copyright © 2015-2019 云南然成科技有限公司 保留公司所有权利

资讯公告 | 然成问吧 | 关于我们 | 联系我们