«
理解学习PHP编码规范之源文件的编码规范

时间:2008-5-31    作者:Deri    分类: 分享


   <p>  开头注释<p>  所有的源文件都应该在开头有一个C语言风格的注释,其中列出类名、功能、版本信息、日期、作者和版权声明:</p><code>/*<br />  * 类名<br />  * 功能<br />  * 版本<br />  * 日期<br />  * 作者<br />  * 版权<br />  */</code></p><p>  如果对文件进行了修改,应该在文件头中说明修改目的、修改日期、修改人,并变更文件的版本信息;如果修改问文件的一部分,则在文件中进行注释即可,并且标识出修改部分的起止位置</p><code>……<br />/*<br />  * 修改目的<br />  * 修改日期<br />  * 修改人<br />  * 版本<br />  */<br />……</code></p><p>  修改起始</p><p>  ……</p><p>  ……</p><p>  修改结束</p><p>  ……</p><p>  3.2 引入语句</p><p>  引入语句应该位于文件的头部,并在引入时说明引入文件的作用。例如:</p><code>//数据库操作类<br />require( “db.php” );</code><p>  3.3 类的声明</p><p>  1 类文档注释(/**……*/) 该注释中所需包含的信息,参见"文档注释"</p><p>  2 类的声明</p><p>  3 类实现的注释(/*……*/)如果有必要的话 该注释应包含任何有关整个类的信息,而这些信息又不适合作为类文档注释。</p><p>  4 类的(静态)变量 首先是类的公共变量,随后是保护变量,再后是包一级别的变量(没有访问修饰符,access modifier),最后是私有变量。</p><p>  5 实例变量 首先是公共级别的,随后是保护级别的,再后是包一级别的(没有访问修饰符),最后是私有级别的。</p><p>  6 构造器</p><p>  7 方法 这些方法应该按功能,而非作用域或访问权限,分组。例如,一个私有的类方法可以置于两个公有的实例方法之间。其目的是为了更便于阅读和理解代码</p>
<p> </p>

   <p>  3.4 缩进排版</p><p>  4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个),所以在某些编辑器中,需要特别指定一下制表符的长度为4(UltraEdit),而在某些编辑器中,会将制表符转换为空格</p><p>  3.5 行长度</p><p>  尽量避免一行的长度超过80个字符,因为很多终端和工具不能很好处理之。</p><p>  3.6 换行</p><p>  当一个表达式无法容纳在一行内时,可以依据如下一般规则断开之:</p><p>  - 在一个逗号后面断开</p><p>  - 在一个操作符前面断开</p><p>  - 宁可选择较高级别(higher-level)的断开,而非较低级别(lower-level)的断开</p><p>  - 新的一行应该与上一行同一级别表达式的开头处对齐</p><p>  - 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边,那就代之以缩进8个空格。</p><p>  以下是断开方法调用的一些例子:</p><code>someMethod(longExpression1, longExpression2, longExpression3,<br />              longExpression4, longExpression5);$var = someMethod1(longExpression1,<br />                  someMethod2(longExpression2,<br />                               longExpression3));</code></p><p>  以下是两个断开算术表达式的例子。前者更好,因为断开处位于括号表达式的外边,这是个较高级别的断开。</p><code>$longName1 = $longName2 * ($longName3 + $longName4 - $longName5)<br />             + 4 * $longname6; //使用这种缩进方式<br />$longName1 = $longName2 * ($longName3 + $longName4<br />                    - $longName5) + 4 * $longname6; //避免这种</code></p>
 <p> </p>

   <p>  以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和第三行移得很靠右,所以代之以缩进8个空格</p><code>//传统的缩进方式<br />function someMethod($anArg, $anotherArg, $yetAnotherArg,<br />           $andStillAnother) {<br />...<br />}<br />//利用8个连续空格避免过渡的缩进<br />function horkingLongMethodName($anArg,<br />      $anotherArg, $yetAnotherArg,<br />      $andStillAnother) {<br />...<br />}</code></p><p>  if语句的换行通常使用8个空格的规则,因为常规缩进(4个空格)会使语句体看起来比较费劲。比如:</p><code>//不要使用这种缩进方式<br />if ((condition1 && condition2)<br />   || (condition3 && condition4)<br />   ||!(condition5 && condition6)) { //错误的换行方式,没有进行缩进<br />   doSomethingAboutIt(); //条件与此句对齐,造成阅读程序时很可能漏过此句<br />}<br />//应该使用这种缩进方式<br />if ((condition1 && condition2)<br />     || (condition3 && condition4)<br />     ||!(condition5 && condition6)) {<br />   doSomethingAboutIt();<br />}<br />//或者这样的缩进方式也可以<br />if ((condition1 && condition2) || (condition3 && condition4)<br />         ||!(condition5 && condition6)) {<br />   doSomethingAboutIt();<br />}</code></p><p>  这里有三种可行的方法用于处理三元运算表达式:</p><code>$alpha = (aLongBooleanExpression) ? beta : gamma;<br />$alpha = (aLongBooleanExpression) ? beta<br />                  : gamma;<br />$alpha = (aLongBooleanExpression)<br />     ? beta<br />     : gamma;</code></p>