由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格。在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。
示例:如下例子不符合规范
复制代码 代码如下:
$i=0;
if($i<7) ...
if ( ($i < 7)&&($j > 8) ) ...
for($i=0; $i<$size; $i++) ...
$i=($j < $size)?0:1;
do_stuff( $i, "foo", $b );
应如下书写:
复制代码 代码如下:
$i = 0;
if ($i < 7) ...
if (($i < 7) && ($j > 8)) ...
for ($i = 0; $i < $size; $i++) ...
$i = ($j < $size) ? 0 : 1;
do_stuff($i, "foo", $b);
4.9. 字符串连接符
当使用字符串连接符时必须在句点(.)两侧加上空格。
示例:如下例子不符合规范
复制代码 代码如下:
$str = ‘<img src=https://www.jb51.net/article/”'.$thumb_url.'” />';
$str = ‘<img src=https://www.jb51.net/article/”' .$thumb_url. ‘”/>';
应如下书写:$str = ‘<img src=https://www.jb51.net/article/”' . $thumb_url . ‘” />';
4.10. 空行的使用
谁也不愿意看到挤在一堆的无序的代码。我们在写代码的时候总是会利用一些空行来增加代码可读性。合理的利用空格来区分代码段会使代码的逻辑思路更加明确。我们强行规定的空行有以下两种情况:
•<?php 之后必须有且只有1个空行
•?> 之前必须有且只有1个空行
•两个函数之间必须有1个空行。
•return、die、exit之前如果有其他语句的情况下应加上一个空行。
在代码中我们不允许在行尾有多余的空格。
5. 注释
5.1. 文件头部模板
/**
* ShopEx网上商店 文件中文名称
* 类或者文件的说明,此处可以使用html
*
* @package
* @version $Id$
* @copyright 2003-2008 Shanghai ShopEx Network Tech. Co., Ltd.
* @license Commercial
* =================================================================
*/
5.2. 函数头部注释
每个函数之前应当有注释,告诉一个程序员使用这个函数所需要知道的事情。一个最小化的注释应包括:每个参数的意义,期望的输入,函数的输出。注释还应当给出在错误条件下(还有具体是什么错误条件)这个函数的行为。(注释应该确保)其他人不必察看这个函数的代码,就可以自信地在自己的代码中调用这个函数。
另外,为任何技巧性的,晦涩的或者并非显而易见的代码添加注释,无疑是我们应该做的事情。对文档尤其重要的是你的代码所做的任何假设,或者它正确运转的前提。任何一个开发者应该能够查看应用程序的任意部分,并且在合理的时间内断定(代码的执行中)发生了什么。
复制代码 代码如下:
/**
* some_func
* 函数的含义说明
* <div>这部分可以随意输入<b>html</b></div>
* 因为这是phpdocument的约定。
*
* @param mixed $arg1 参数一的说明
* @param mixed $arg2 参数二的说明
* @access public
* @return bool
*/
5.3. 删除废除的注释
废除的注释,注释的代码要及时删除