PHP编码规范
PHP的书写规则
- 缩进
使用制表符(Tab键)对不同层级的代码进行缩进,缩进单位为4个空格左右。如果开发工具有多种,则需要在开发工具中统一进行设置。 - 大括号{ }
建议将一对大括号整体放到关键字的下方,保持同列。一般推荐使用此种方式。例如:
if ($expr)
{ …}
也可以首括号与关键词同行,尾括号与关键字同列。例如:
if ($expr) {
…}
- 关键字、小括号、函数、运算符
(1)小括号和关键字(如if、for等)间,使用空格进行分隔。例如:
(2)函数后的小括号要和函数名紧密相连,这样可以有效区分PHP关键字和函数。例如:
round($num) //round和“(”之间没有空格
(3)运算符与两边的变量或表达式间要有一个空格(字符连接运算符“.”除外)。例如:
(4)当代码段较长时,应在关键位置加入空行,以免阅读疲劳。注意,两个代码块间只使用一个空行,禁止使用多行。
(5)尽量不要在return返回语句中使用小括号。例如:
return 1; //除非是必要,否则不需要使用小括号
PHP的命名规范
首先,类名、函数名、变量名等都必须见名知意,简单易懂,避免使用模棱两可的命名。
(1)类命名的要求和规范如下。
☑ 使用大写字母作为词的分隔,其他字母均使用小写。
☑ 名字的首字母使用大写。
☑ 不要使用下画线()。
例如,Name、SuperMan、BigClassObject等都是合理的类命名。
(2)类属性命名的要求和规范如下。
☑ 属性命名应该以字符m为前缀。
☑ 前缀m后采用与类命名一致的规则。
☑ m总是在名字的开头起修饰作用,就像以r开头表示引用一样。
例如,mValue、mLongString等都是合适的类属性命名。
(3)方法命名的要求和规范如下。
方法用于执行一个动作,达到某个目的,因此方法名应清晰说明方法是干什么用的。一般名称的前缀和后缀都有一定的规律,如Is(判断)、Get(得到)、Set(设置)等。
(4)方法中参数命名的要求和规范如下。
☑ 第一个字符使用小写字母。
☑ 首字符后的所有字符参照类命名规则,首字符大写。
(5)变量命名的要求和规范如下。
☑ 所有字母都使用小写。
☑ 使用“”作为每个词的分界。
例如,
m
s
g
e
r
r
o
r
、
msg_error、
msgerror、chk_pwd等都是合适的变量命名。
(6)引用变量前要带前缀r。
(7)全局变量前应带前缀g,如global $gTest、global $g等。
(8)常量/全局常量应该全部使用大写字母,单词之间用“”来分隔。
(9)静态变量前应带前缀s。
(10)函数命名时,所有单词都要使用小写字母,单词间使用“”进行分隔。