如今的 Web 开发,不再是一个人就可以全部完成的,尤其是一些大型的项目,往往需要十几人,甚至几十人来共同完成。在开发过程中,难免会有新的开发人员参与进来,那么这个新的开发人员在阅读前任留下的代码时,就会有问题了——这个变量起到什么作用?那个函数实现什么功能?这个类又是在哪里被使用到……诸如此类。这时,编码规范的重要性就体现出来了。
什么是编码规范
以 PHP 开发为例,编码规范就是融合了开发人员长时间积累下来的经验,形成了一种良好统一的编程风格,这种良好统一的编程风格会在团队开发或二次开发时起到事半功倍的效果。编码规范是一种总结性的说明和介绍,并不是强制性的规则。从项目长远的发展以及团队效率来考虑,遵守编码规范是十分必要的。
遵守编码规范的好处有很多,比如利于开发人员理解代码,理清程序的状况;同时可以提高程序的可读性,有利于相关设计人员的交流,提高软件质量;而且有利于程序的后期维护,降低软件成本。
PHP中的编码规范
1) 缩进
根据代码的层级关系使用适当数量的制表符(Tab 键)进行缩进,缩进单位为 4 个空格,如果开发工具中有多种类型的缩进样式,则需要在开发工具中统一设置。如下所示:
for ($i = 1; $i <= 9; $i++){
for ($j = 1; $j <= $i; $j++){
for ($y = 1; $y <= $i; $y++){
… …
}
}
}
2) 大括号“{ }”
对于代码中的大括号,有两种放置规则是可以选择,可以将大括号放置在关键字的下方,如下所示:
if ($expr)
{
… …
}
也可以将大括号的左半边放置在关键词的后面,与关键词同行,大括号的右半边放置在关键字的下方,与关键字同列,如下所示:
if ($expr){
… …
}
两种方式并没有太大差别,多数人都习惯使用第一种方式。
3) 关键字、小括号、函数、运算符
尽量不要把小括号和关键字紧贴在一起,建议使用空格将它们分隔开,如下所示:
if ($expr){ // if 和 “(” 之间有一个空格
… …
}
小括号和函数要紧贴在一起,以便区分关键学和函数。如下所示:
round($num) // round 和 “(” 之间没有空格
运算符与两边的变量或表达式建议使用一个空格(字符连接运算符.
除外)将它们分隔开。如下所示:
while ($boo == true){
… …
}
当代码段比较长时,上下两个代码段之间应当加入一个空行,不要使用多个空行。另外,除非必要,否则尽量不要在 return 返回语句中使用小括号,例如:
return 1;
本节中涉及到了一些还没有介绍过的内容,大家不必担心,后面会详细介绍,现阶段只要了解对应的语法规范即可。
原创文章,作者:奋斗,如若转载,请注明出处:https://blog.ytso.com/23988.html