PHP基础：PHP编码规范三

shiyaowen

       
       
       
       
       
       
       
       
       
       
3.6.
switch [color="#000000"]格式
[color="#000000"]
·
[color="#000000"]当一个[color="#000000"]case[color="#000000"]块处理后，直接转到下一个[color="#000000"]case[color="#000000"]块处理，在这个[color="#000000"]case[color="#000000"]块的最后应该加上注释。
[color="#000000"]
·
default case[color="#000000"]总应该存在，它应该不被到达，然而如果到达了就会触发一个错误。
[color="#000000"]
·
[color="#000000"]如果你要创立一个变量，那就把所有的代码放在块中。
[color="#000000"]
[color="#000000"]例如
[color="#000000"]
switch
(...) [color="#000000"]
{
[color="#000000"]
case
1: [color="#000000"]
...
[color="#000000"]
//
FALL THROUGH [color="#000000"]
case
2: [color="#000000"]
{
[color="#000000"]
$v
= get_week_number(); [color="#000000"]
...
[color="#000000"]
}
[color="#000000"]
break;
[color="#000000"]
default:
[color="#000000"]
}
[color="#000000"]
3.7.
continue,break [color="#000000"]和
? [color="#000000"]的使用
[color="#000000"]
3.7.1.
Continue [color="#000000"]和
Break [color="#000000"]
Continue
[color="#000000"]和
break [color="#000000"]其实是变相的隐蔽的
goto[color="#000000"]方法。
[color="#000000"]
Continue
[color="#000000"]和
break [color="#000000"]像
goto
[color="#000000"]一样，它们在代码中是有魔力的，所以要节俭（尽可能少）的使用它们。使用了这一简单的魔法，由于一些未公开的原因，读者将会被定向到只有上帝才知道的地方去。
[color="#000000"]
[color="#000000"]Continue[color="#000000"]有两个主要的问题：
[color="#000000"]
·
[color="#000000"]它可以绕过测试条件。
[color="#000000"]
·
[color="#000000"]它可以绕过等[color="#000000"]/[color="#000000"]不等表达式。
[color="#000000"]
[color="#000000"]看看下面的例子，考虑一下问题都在哪儿发生：
[color="#000000"]
while
(TRUE) [color="#000000"]
{
[color="#000000"]
...
[color="#000000"]
//
A lot of code [color="#000000"]
...
[color="#000000"]
if
(/* some condition */) { [color="#000000"]
continue;
[color="#000000"]
}
[color="#000000"]
...
[color="#000000"]
//
A lot of code [color="#000000"]
...
[color="#000000"]
if
( $i++ > STOP_VALUE) break; [color="#000000"]
}
[color="#000000"]
[color="#000000"]注意："A
lot of code"[color="#000000"]是必须的，这是为了让程序员们不能那么容易的找出错误。
[color="#000000"]
[color="#000000"]通过以上的例子，我们可以得出更进一步的规则：continue
[color="#000000"]和
break [color="#000000"]混合使用是引起灾难的正确方法。
[color="#000000"]
3.7.2.
?: [color="#000000"]
[color="#000000"]麻烦在于人们往往试着在
? [color="#000000"]和
: [color="#000000"]之间塞满了许多的代码。以下的是一些清晰的连接规则：
[color="#000000"]
·
[color="#000000"]把条件放在括号内以使它和其他的代码相分离。
[color="#000000"]
·
[color="#000000"]如果可能的话，动作可以用简单的函数。
[color="#000000"]
·
[color="#000000"]把所做的动作，“[color="#000000"]?[color="#000000"]”，“[color="#000000"]:[color="#000000"]”放在不同的行，除非他们可以清楚的放在同一行。
[color="#000000"]
[color="#000000"]例如
[color="#000000"]
(condition)
? funct1() : func2(); [color="#000000"]
or
[color="#000000"]
(condition)
[color="#000000"]
?
long statement [color="#000000"]
:
another long statement; [color="#000000"]
3.8.
[color="#000000"]声明块的定位
[color="#000000"]
·
[color="#000000"]声明代码块需要对齐。
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
·
[color="#000000"]清晰。
[color="#000000"]
·
[color="#000000"]变量初始化的类似代码块应该列表。
[color="#000000"]
·
&[color="#000000"]应靠近类型，而不是变量名。
[color="#000000"]
[color="#000000"]例如
[color="#000000"]
var
$mDate [color="#000000"]
var&
$mrDate [color="#000000"]
var&
$mrName [color="#000000"]
var
$mName [color="#000000"]
$mDate
= 0; [color="#000000"]
$mrDate
= NULL; [color="#000000"]
$mrName
= 0; [color="#000000"]
$mName
= NULL; [color="#000000"]
3.9.
[color="#000000"]每行一个语句
[color="#000000"]
[color="#000000"]除非这些语句有很密切的联系，否则每行只写一个语句。
[color="#000000"]
3.10.
[color="#000000"]短方法
[color="#000000"]
[color="#000000"]方法代码要限制在一页内。
[color="#000000"]
3.11.
[color="#000000"]记录所有的空语句
[color="#000000"]
[color="#000000"]总是记录下[color="#000000"]for[color="#000000"]或者是[color="#000000"]while[color="#000000"]的空块语句，以便清楚的知道该段代码是漏掉了，还是故意不写的。
[color="#000000"]
while
($dest++ = $src++) [color="#000000"]
;
// VOID [color="#000000"]
3.12.
[color="#000000"]不要采用缺省方法测试非零值
[color="#000000"]
[color="#000000"]不要采用缺省值测试非零值，也就是使用：
[color="#000000"]
if
(FAIL != f()) [color="#000000"]
[color="#000000"]比下面的方法好：
[color="#000000"]
if
(f()) [color="#000000"]
[color="#000000"]即使
FAIL [color="#000000"]可以含有
0 [color="#000000"]值
[color="#000000"]，也就是[color="#000000"]PHP[color="#000000"]认为[color="#000000"]false[color="#000000"]的表示。在某人决定用[color="#000000"]-1[color="#000000"]代替[color="#000000"]0[color="#000000"]作为失败返回值的时候，一个显式的测试就可以帮助你了。就算是比较值不会变化也应该使用显式的比较；例如：if
(!($bufsize % strlen($str)))[color="#000000"]应该写成：if
(($bufsize % strlen($str)) ==
0)[color="#000000"]以表示测试的数值（不是布尔）型。一个经常出问题的地方就是使用[color="#000000"]strcmp[color="#000000"]来测试一个字符等式，结果永远也不会等于缺省值。
[color="#000000"]
[color="#000000"]非零测试采用基于缺省值的做法，那么其他函数或表达式就会受到以下的限制:
[color="#000000"]
·
[color="#000000"]只能返回[color="#000000"]0[color="#000000"]表示失败，不能为[color="#000000"]/[color="#000000"]有其他的值。
[color="#000000"]
·
[color="#000000"]命名以便让一个真[color="#000000"](true)[color="#000000"]的返回值是绝对显然的，调用函数[color="#000000"]IsValid()[color="#000000"]而不是[color="#000000"]Checkvalid()[color="#000000"]。
[color="#000000"]
3.13.
[color="#000000"]布尔逻辑类型
[color="#000000"]
[color="#000000"]大部分函数在[color="#000000"]FALSE[color="#000000"]的时候返回[color="#000000"]0[color="#000000"]，但是发挥非[color="#000000"]0[color="#000000"]值就代表[color="#000000"]TRUE[color="#000000"]，因而不要用[color="#000000"]1[color="#000000"]（[color="#000000"]TRUE[color="#000000"]，[color="#000000"]YES[color="#000000"]，诸如此类）等式检测一个布尔值，应该用[color="#000000"]0[color="#000000"]（[color="#000000"]FALSE[color="#000000"]，[color="#000000"]NO[color="#000000"]，诸如此类）的不等式来代替：
[color="#000000"]
if
(TRUE == func()) { ... [color="#000000"]
[color="#000000"]应该写成：
[color="#000000"]
if
(FALSE != func()) { ... [color="#000000"]
3.14.
[color="#000000"]通常避免嵌入式的赋值
[color="#000000"]
[color="#000000"]有时候在某些地方我们可以看到嵌入式赋值的语句，那些结构不是一个比较好的少冗余，可读[color="#000000"]**[color="#000000"]强的方法。
[color="#000000"]
while
($a != ($c = getchar())) [color="#000000"]
{
[color="#000000"]
process
the character [color="#000000"]
}
[color="#000000"]
[color="#000000"]++[color="#000000"]和[color="#000000"]--[color="#000000"]操作符类似于赋值语句。因此，出于许多的目的，在使用函数的时候会产生副作用。使用嵌入式赋值提高运行时[color="#000000"]**[color="#000000"]能是可能的。无论怎样，程序员在使用嵌入式赋值语句时需要考虑在增长的速度和减少的可维护[color="#000000"]**[color="#000000"]两者间加以权衡。例如：
[color="#000000"]
a
= b + c; [color="#000000"]
d
= a + r; [color="#000000"]
[color="#000000"]不要写成：
[color="#000000"]
d
= (a = b + c) + r;
[color="#000000"]
[color="#000000"]虽然后者可以节省一个周期。但在长远来看，随着程序的维护费用渐渐增长，程序的编写者对代码渐渐遗忘，就会减少在成熟期的最优化所得。
[color="#000000"]
4.
[color="#000000"]帮助与共享
[color="#000000"]
4.1.
[color="#000000"]重用您和其他人的艰苦工作
[color="#000000"]
[color="#000000"]跨工程的重用在没有一个通用结构的情况下几乎是不可能的。对象符合他们现有的服务需求，不同的过程有着不同的服务需求环境，这使对象重用变得很困难。
[color="#000000"]
[color="#000000"]开发一个通用结构需要预先花费许多的努力来设计。当努力不成功的时候，无论出于什么原因，有几种办法推荐使用：
[color="#000000"]
4.2.
[color="#000000"]请教！给群组发[color="#000000"]Email[color="#000000"]求助
[color="#000000"]
[color="#000000"]这个简单的方法很少被使用。因为有些程序员们觉得如果他向其他人求助，会显得自己水平低，这多傻啊[color="#000000"]![color="#000000"]做新的有趣的工作，不要一遍又一遍的做别人已经做过的东西。
[color="#000000"]
[color="#000000"]如果你需要某些事项的源代码，如果已经有某人做过的话，就向群组发[color="#000000"]email[color="#000000"]求助。结果会很惊喜哦！
[color="#000000"]
[color="#000000"]在许多大的群组中，个人往往不知道其他人在干什么。你甚至可以发现某人在找一些东西做，并且自愿为你写代码，如果人们在一起工作，外面就总有一个金矿。
[color="#000000"]
4.3.
[color="#000000"]告诉！当你在做事的时候，把它告诉所有人
[color="#000000"]
[color="#000000"]如果你做了什么可重用的东西的话，让其他人知道。别害羞，也不要为了保护自豪感而把你的工作成果藏起来。一旦养成共享工作成果的习惯，每个人都会获得更多。
[color="#000000"]
4.4.
[color="#000000"]小型代码库
[color="#000000"]
[color="#000000"]对于代码重用，一个常见的问题就是人们不从他们做过的代码中做库。一个可重用的类可能正隐蔽在一个程序目录并且决不会有被分享的激动，因为程序员不会把类分拆出来加入库中。
[color="#000000"]
[color="#000000"]这样的其中一个原因就是人们不喜欢做一个小库，对小库有一些不正确感觉。把这样的感觉克服掉吧，电脑才不关心你有多少个库呢。
[color="#000000"]
[color="#000000"]如果你有一些代码可以重用，而且不能放入一个已经存在的库中，那么就做一个新的库吧。如果人们真的考虑重用的话，库不会在很长的一段时间里保持那么小的。
[color="#000000"]
4.5.
[color="#000000"]知识库
[color="#000000"]
[color="#000000"]很多公司不清楚现有什么代码可用，而且大多数程序员仍然没有通过沟通他们已经做过了什么，或者一直在询问现存什么代码可用。解决这个的方法是有一个可用的知识库。
[color="#000000"]
[color="#000000"]理想的情况是，程序员可以到一个[color="#000000"]WEB[color="#000000"]页，浏览或者查询打包的知识库列表，找到他们所要的。建立一个程序员可以自动维护的知识库系统，是一个很不错的做法。如果有一个专门的管理员来负责维护这个知识库，那当然更好。
[color="#000000"]
[color="#000000"]另一种方法是自动的从代码中产生知识库的做法。把通用的类、方法和标头（subsystem
headers[color="#000000"]）作为手册或者是知识库的一个条目。
[color="#000000"]
5.
[color="#000000"]书写注释
[color="#000000"]
5.1.
[color="#000000"]讲一个故事
[color="#000000"]
[color="#000000"]把你的注释当作描述系统的一个故事。并且使得你的注释能被机器解析后，以固定的格式放到手册中去。类的注释是故事的一部分，方法的名称、方法的注释、方法的实现也是故事一部分。所有的这些部分编织在一起，使得人们在以后的时间里能够准确的知道你干了什么，为什么这么做。
[color="#000000"]
5.2.
[color="#000000"]归档注释
[color="#000000"]
[color="#000000"]注释的要归档才有意义，否则，假如在一个地方放一条注释描述你做了什么选择和你为什么这么做，只有考古学家才能发现这是最有用的信息。（如何归档另行规范）
[color="#000000"]
5.3.
[color="#000000"]注释结构
[color="#000000"]
[color="#000000"]工程的每部分都有特定的注释结构。
[color="#000000"]程序中的注释，这里给出示例作为规范，注释中以
* @ [color="#000000"]为关键字的开始，以[color="#000000"]:[color="#000000"]为注释关键字结尾。
[color="#000000"]
5.3.1.
[color="#000000"]预定义关键字
[color="#000000"]
[color="#000000"]关键字
[color="#000000"]含义
[color="#000000"]
Purpose
[color="#000000"]表示类、属[color="#000000"]**[color="#000000"]、方法要做些什么或者什么含义。
[color="#000000"]
Package
Name [color="#000000"]类名
[color="#000000"]
Author
[color="#000000"]作者
[color="#000000"]
Modifications
[color="#000000"]修改记录（编号规则为“[color="#000000"]No[color="#000000"]”＋日期＋“－”＋序号）
[color="#000000"]
See
[color="#000000"]参考
[color="#000000"]
Method
Name [color="#000000"]方法名
[color="#000000"]
Parameter
[color="#000000"]参数名（包括类型）
[color="#000000"]
Return
[color="#000000"]返回值（包括类型）
[color="#000000"]
Attribute/Variable
Name [color="#000000"]属[color="#000000"]**/[color="#000000"]变量名
[color="#000000"]
Type
[color="#000000"]属[color="#000000"]**/[color="#000000"]变量类型
[color="#000000"]
5.3.2.
[color="#000000"]类的注释
[color="#000000"]
/**
[color="#000000"]
*
@ Purpose: [color="#000000"]
*
[color="#000000"]访问数据库的类，以[color="#000000"]ODBC[color="#000000"]作为通用访问接口
[color="#000000"]
*
@Package Name: Database [color="#000000"]
*
@Author: Forrest Gump
gump@crtvu.edu.cn
[color="#000000"]
*
@Modifications: [color="#000000"]
*
No20020523-100: [color="#000000"]
*
odbc_fetch_into()[color="#000000"]参数位置第二和第三个位置调换
[color="#000000"]
*
John Johnson
John@crtvu.edu.cn
[color="#000000"]
*
@See: ([color="#000000"]参照)
[color="#000000"]
*/
[color="#000000"]
class
Database [color="#000000"]
{
[color="#000000"]
……
[color="#000000"]
}
[color="#000000"]
5.3.3.
[color="#000000"]方法注释
[color="#000000"]
/**
[color="#000000"]
*
@Purpose: [color="#000000"]
*
[color="#000000"]执行一次查询
[color="#000000"]
*
@Method Name: Query() [color="#000000"]
*
@Parameter: string $queryStr SQL[color="#000000"]查询字符串
[color="#000000"]
*
@Return: mixed [color="#000000"]查询返回值（结果集对象）
[color="#000000"]
*/
[color="#000000"]
[color="#000000"]function[color="#000000"]（[color="#000000"]$queryStr[color="#000000"]）{……}
[color="#000000"]
5.3.4.
[color="#000000"]属[color="#000000"]**[color="#000000"]或变量注释
[color="#000000"]
/**
[color="#000000"]
*
@Purpose: [color="#000000"]
*
[color="#000000"]数据库连接用户名
[color="#000000"]
*
@Attribute/Variable Name: mDbUserName [color="#000000"]
*
@Type: string [color="#000000"]
*/
[color="#000000"]
var
mDbUserName; [color="#000000"]
5.3.5.
if (0)[color="#000000"]来注释外部代码块
[color="#000000"]
[color="#000000"]有时需要注释大段的测试代码，最简单的方法就是使用if
(0)[color="#000000"]块：
[color="#000000"]
function
example() [color="#000000"]
{
[color="#000000"]
great
looking code [color="#000000"]
if
(0) { [color="#000000"]
lots
of code [color="#000000"]
}
[color="#000000"]
more
code [color="#000000"]
}
[color="#000000"]
[color="#000000"]你不能使用[color="#000000"]/**/[color="#000000"]，因为注释内部不能包含注释，而大段的程序中可以包含注释。
[color="#000000"]
5.3.6.
[color="#000000"]目录文档
[color="#000000"]
[color="#000000"]所有的目录下都需要具有[color="#000000"]README[color="#000000"]文档，其中包括：
[color="#000000"]
·
[color="#000000"]该目录的功能及其包含内容
[color="#000000"]
·
[color="#000000"]一个对每一文件的在线说明（带有[color="#000000"]link[color="#000000"]），每一个说明通常还应该提取文件标头的一些属[color="#000000"]**[color="#000000"]名字。
[color="#000000"]
·
[color="#000000"]包括设置、使用说明
[color="#000000"]
·
[color="#000000"]指导人们如何连接相关资源：
[color="#000000"]
o
[color="#000000"]源文件索引
[color="#000000"]
o
[color="#000000"]在线文档
[color="#000000"]
o
[color="#000000"]纸文档
[color="#000000"]
o
[color="#000000"]设计文档
[color="#000000"]
·
[color="#000000"]其他对读者有帮助的东西
[color="#000000"]
[color="#000000"]考虑一下，当每个原有的工程人员走了，在[color="#000000"]6[color="#000000"]个月之内来的一个新人，那个孤独受惊吓的探险者通过整个工程的源代码目录树，阅读说明文件，源文件的标头说明等等做为地图，他应该有能力穿越整个工程。
[color="#000000"]
6.
[color="#000000"]其他
[color="#000000"]
·
[color="#000000"]采用面向对象的设计方法；
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
[color="#000000"]毫无疑问这是最接近人们自然思维的方法，可能前期会觉得没有直接书写来得快，能否试着保留自己的看法？好戏在后头！
[color="#000000"]
·
[color="#000000"]类的定义采用一个文件一个类，并且类名和文件名相同；
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
o
[color="#000000"]越来越多的人接受了这种做法
[color="#000000"]
o
[color="#000000"]事实证明这种方法使得项目的逻辑结构更清晰
[color="#000000"]
·
[color="#000000"]类定义文件中，定义体之外不得出现诸如[color="#000000"]echo[color="#000000"]、[color="#000000"]print[color="#000000"]等输出语句；
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
[color="#000000"]出现这样的语句，应该当做出现[color="#000000"]bug[color="#000000"]来看。
[color="#000000"]
·
[color="#000000"]输出网页的页面不出现[color="#000000"]SQL[color="#000000"]语句
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
[color="#000000"]这是[color="#000000"]n[color="#000000"]层结构的编程思想所致，每层的任务不同，虽然可以越权行使，可能这样很快捷，但我们不赞成这么干。
[color="#000000"]
·
[color="#000000"]进行[color="#000000"]SQL[color="#000000"]执行的数据必须进行有效[color="#000000"]**[color="#000000"]检测
[color="#000000"]
[color="#000000"]特殊符号：
[color="#000000"]
[color="#000000"]对于MS
SQL Server[color="#000000"]，’%_[
] [color="#000000"]这些符号都是在书写[color="#000000"]SQL[color="#000000"]语句中的特殊含义字符，在[color="#000000"]SQL[color="#000000"]执行前需要对这些字符进行处理。
[color="#000000"]
[color="#000000"]脚本符号：
[color="#000000"]
[color="#000000"]对于[color="#000000"]PHP[color="#000000"]脚本标记，如[color="#000000"]，在进入数据库前需要检测处理。
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
[color="#000000"]这是数据库编程的一个约定，很多参考书上也是这么说，这里需要强调一下。
[color="#000000"]
·
[color="#000000"]在[color="#000000"]HTML[color="#000000"]网页中尽量不要穿插[color="#000000"]PHP[color="#000000"]代码
[color="#000000"]
[color="#000000"]循环代码和纯粹变量输出（类似于[color="#000000"][color="#000000"]）除外。
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
o
[color="#000000"]需要说明的是我们工作的上游，页面设计者的工作，假如在页面中穿插代码，将破坏结构，这应当是我们需要避免的。
[color="#000000"]
o
[color="#000000"]在这里的[color="#000000"]PHP[color="#000000"]代码只负责显示，多余的代码显然是不应该的。
[color="#000000"]
·
[color="#000000"]没有含义的数字
[color="#000000"]
[color="#000000"]一个在源代码中使用了的赤裸裸的数字是不可思议的数字，因为包括作者，在三个月内，没人它的含义。例如：
[color="#000000"]
if
(22 == $foo) { start_thermo_nuclear_war(); } [color="#000000"]
else
if (19 == $foo) { refund_lotso_money(); } [color="#000000"]
else
if (16 == $foo) { infinite_loop(); } [color="#000000"]
else
{ cry_cause_im_lost(); }
[color="#000000"]
[color="#000000"]在上例中[color="#000000"]22[color="#000000"]和[color="#000000"]19[color="#000000"]的含义是什么呢？如果一个数字改变了，或者这些数字只是简单的错误，你会怎么想？
[color="#000000"]
[color="#000000"]使用不可思议的数字是该程序员是业余运动员的重要标志[color="#000000"].[color="#000000"]
[color="#000000"]你应该用[color="#000000"]define()[color="#000000"]来给你想表示某样东西的数值一个真正的名字，而不是采用赤裸裸的数字，例如：
[color="#000000"]
define("PRESIDENT_WENT_CRAZY",
"22"); [color="#000000"]
define("WE_GOOFED",
"19"); [color="#000000"]
define("THEY_DIDNT_PAY",
"16"); [color="#000000"]
if
(PRESIDENT_WENT_CRAZY == $foo) { start_thermo_nuclear_war(); } [color="#000000"]
else
if (WE_GOOFED == $foo) { refund_lotso_money(); } [color="#000000"]
else
if (THEY_DIDNT_PAY == $foo) { infinite_loop(); } [color="#000000"]
else
{ happy_days_i_know_why_im_here(); } [color="#000000"]
[color="#000000"]现在不是变得更好了么？[color="#000000"]
7.
PHP[color="#000000"]文件扩展名
[color="#000000"]
[color="#000000"]常见的[color="#000000"]PHP[color="#000000"]文件的扩展名有：html,
.php, .php3, .php4, .phtml, .inc, .class... [color="#000000"]
[color="#000000"]这里我们约定：
[color="#000000"]
·
[color="#000000"]所有浏览者可见页面使用.html
[color="#000000"]
·
[color="#000000"]所有类、函数库文件使用.php
[color="#000000"]
[color="#000000"]理由
[color="#000000"]
·
[color="#000000"]扩展名描述的是那种数据是用户将会收到的。[color="#000000"]PHP[color="#000000"]是解释为[color="#000000"]HTML[color="#000000"]的。
[color="#000000"]
8.
PHP[color="#000000"]代码标记
[color="#000000"]
[color="#000000"]统一使用[color="#000000"]，只输出变量时[color="#000000"]
               
               
               

本文来自ChinaUnix博客，如果查看原文请点：http://blog.chinaunix.net/u/30647/showart_245212.html