PHP-程序编码规范.docVIP

PHP程序编码标准

Anyviolationtothisguideisallowedifitenhancesreadability.

所有的代码都要变成可供他人容易阅读的

良好的代码书写习惯+良好的注释习惯+PhpDocumentor=程序说明书

整理日期:2014-05-06

参考修改自:

.NET编程标准

华为编程标准

JavaScript程序编码标准(cloudwater译)

PHP开发标准(未知出处)

PHPCodingStandard(FredrikKristiansen/DBMedialab)

等

前言

第1章排版规那么

1.1缩进

1.2空格规那么

1.2.1逻辑运算符前后必须加空格

1.2.2多个参数分隔时必须加空格

1.2.3语法关键字后必须加空格

1.2.4字符串和变量连接规那么

1.3换行

1.3.1较长的语句(80字符)

第2章命名标准

2.1变量命名

2.1.1局部变量

2.1.2全局变量命名

2.1.3静态变量命名

2.1.4引用变量和函数返回引用

2.1.5临时变量命名

2.1.6方法中参数命名

2.2命名定义/全局常量

2.3类命名

2.3.1接口命名原那么

2.3.2Exception命名原那么

2.3.3类库命名

2.3.4方法命名

2.3.5方法/函数命名修饰

2.3.6类属性命名

2.3.7私有属性与私有方法命名

2.3.8对象命名

2.4缩写词不要全部使用大写字母

2.5函数命名

第3章版式规那么

3.1语义分隔

3.2圆括号规那么

PHP程序编码标准

3.3方法/函数

3.4关键字

3.4.1if语句

3.4.2for语句

3.4.4do语句

3.4.5switch语句

3.4.6try语句

3.4.7return语句

第4章编程标准

4.1数组定义规那么

4.2不要采用缺省方法测试非零值

4.3通常防止嵌入式的赋值

4.4布尔逻辑类型

4.5别在对象架构函数中做实际的工作

4.6switch格式

4.7Continue和Break

4.8?:

4.9其他杂项

4.9.1类定义文件中,定义体之外不得出现诸如echo、print等输出语句;

4.9.2在HTML网页中尽量不要穿插PHP代码

4.9.3没有含义的数字

4.9.4PHP文件扩展名

4.9.5总是将恒量放在等号/不等号的左边

4.10SQL规那么

4.10.1输出网页的页面不出现SQL语句

4.10.2进行SQL执行的数据必须进行有效性检测

第5章注释规那么

5.1一般规那么

5.2方法/函数注释

5.3类注释

5.4记录所有的空语句

5.5用if(0)来注释外部代码块

5.6版权信息

第1章排版规那么

1.1缩进

缩进对齐统一使用一种方式;只用4个空格或者只用TAB。

说明:根据实际使用的环境来决定。一些编辑器自动转换TAB为4个空格的距离,但有些也会转换为8

个空格。

块开头对齐赋值:

$book_name

=;//书名

$new_book_name

=;//新书名

$new_book_page_count=0;//新书页计数

说明:一般在函数的开头把所有用到的内部变量都初始化一次,这样可以防止程序的未定义错误,并且

对函数内部变量有个直观的一览。适用于定长字体。

1.2空格规那么

空格应在以下情况时使用:

?跟在((左括号)后面的关键字应被一个空格隔开。

while(true){

函数名与左括号之间不应该有空格。这能帮助区分关键字和函数调用。

functionmyfun(){

所有的二元操作符,除了左括号和左方括号应用空格将其与操作数隔开。

一元操作符与其操作数之间不应有空格,除非操作符是个单词,比方typeof。

每个在控制局部,比方for语句中的;(分号)后须跟一个空格。

for($i=0;$i10;$i++){

每个,(逗号)后应跟一个空格。

?

1.2.1逻辑运算符前后必须加空格

正确$a==$b;

正确$a++;$a––;

错误$a==$b;

$a==$b;

错误$a++;$a––;

备注:加一减一运算符不能加空格。

1.2.2多个参数分隔时必须加空格

错误

$g_pro,$g_user,g_show;

$g_pro,$g_user,$g_show;

get_db_info($host,$user,$passwd);

get_db_in