PHP 编码规范-源文件的编码规范

haidong · 发表于 2010-2-24 13:42:54

<

>3.1 开头注释<

> /* 　* 类名 　* 功能 　* 版本 　* 日期 　* 作者 　* 版权 　*/ 如果对文件进行了修改，应该在文件头中说明修改目的、修改日期、修改人，并变更文件的版本信息；如果修改问文件的一部分，则在文件中进行注释即可，并且标识出修改部分的起止位置<

>……<

>/* 　* 修改目的 　* 修改日期 　* 修改人 　* 版本 　*/<

>…… 修改起始 …… …… 修改结束 ……<

>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;

jinlequan · 发表于 2012-4-25 23:26:07

账号		自动登录	找回密码
密码			论坛注册

PHP 编码规范-源文件的编码规范

客服中心

投诉建议