第一篇博文:百度的代码规范

我其实想找字节跳动的代码规范,因为之前发现字节跳动公司年轻人很多,但是年纪比较大的也不少,就是,我感觉字节跳动是不会“每年固定向社会输出三十岁左右的公司人才”的,但是字节跳动的代码规范比较难找,我就找了百度的,但是百度的太长了。我先贴一下记录了这个代码规范的网址:https://blog.csdn.net/gb4215287/article/details/69940060

总结起来就是:

1.缩进风格编写,缩进空格数为4个,单模块内必须统一。

2.关键字与其后的左括号之间有一个空格,而函数名与左括号之间不应有任何字符包括空格。

3.开始的大括号位于一行的末尾,结束的括号位于最末一行后,且独占一行。首括号也可另起一行,但一个模块内必须统一。

4.if/while等结构体,即使只有一行,也必须加上花括号,不得写成一行。

5.一行代码不得超过120个字节,建议控制在80字节内;一个函数不得超过500行,建议控制在100行以内。

6.else-if语句使用else if形式,不使用elseif形式。

7. 函数名与其后的左括号之间不应有任何字符(包括空格) 函数调用的左括号与其第一个参数之间不应有任何字符(包括空格) 最后一个参数与右括号之间不应有任何字符(包括空格) 参数列表的逗号后面应有一个空格

8. 避免由于对错误的条件做判断带来if的嵌套。

9. 如果过长的话需要另起一行。if 语句的条件若较多较长,应折行;新行以逻辑运算符起始,与第一行 if 左括号后的第一个字符对齐;折行后,每行条件具有独立而明确的语义

10. [建议]多行的”=”可能的话尽量用空格对齐。

11. [强制] [PHP009] Switch语句中每个case的break必须和case间有缩进。

2.12. [强制] [PHP008] 初始化array如果采用多行结构时,数据项部分需要缩进,且最后一个数据项后面的逗号不可省略。

2.13. [建议] 复杂的表达式, 使用括号表明优先级, 而不完全依赖运算符优先级。

2.14. [建议] 同一个代码块的变量定义, 应该尽可能集中在块开始位置,提高可读性。

2.15. [建议] 除模板外,不允许使用?>标记结尾, 避免其后误加的字符干扰页面渲染。

2.16. [建议] 产品线内必须统一换行符的使用, 推荐“n”。

3. 命名

3.1. [强制] [PHP025] 全局变量以g_开头。

3.2. [强制] [PHP004] 常量命名使用全部大写字符,单词之间以’_’连接。

3.3. [建议]对于代码中的常量,建议用常量或define表示,不应直接写在代码中。

3.4. [强制] [PHP010] 关键字true、false、null必须小写

3.5. [强制] [PHP026] 类method命名采用驼峰命名, 普通function采用过程函数风格命名。

3.6. [强制·]类成员变量和局部变量必须采用驼峰命名法,建议增加三字节的类型前缀:arr、str、int、bol、obj等

3.7. [建议]文件(除了类)命名使用小写字母,单词之间以’_’连接。

3.8. [建议]配置文件的名称为配置文件名 + .conf.php, 不涉及类的都小写通过”_”连接。

3.9. [建议]类名应以大写字母开头,每个单词的首字母大写。

3.10. [建议]final放在访问控制符的前面、访问控制符放在static的前面

4. 注释

4.1. [建议]文件、函数、类以及成员变量都应包含注释,关键代码必须有注释。

4.2. [强制] [PHP027] 不能使用#作为单行注释, 多行注释/ * **/不能出现在同一行。

4.3. [强制] [PHP028] 函数必须通过param和return标记指明其参数和返回值。

4.4. [建议] 注释需要遵守phpDocumentor等注释规范,同一团队内部必须保持一致。

4.5. [建议] 必要的地方使用非文档性注释,提高代码易读性。

5. 编码原则

5.1. [建议]对传入或返回的参数进行类型检查和显式转换。

5.2. [强制]对于函数返回值的判断,特别是true/false, 必须用===或!==。

5.3. [强制] [PHP029] 生成对象时,必须使用new Classname(),不能用new Classname。

5.4. [强制]所有文件路径都需要利用框架提供的宏写成绝对路径。

5.5. [建议]对于长时间运行的CLI程序,需要及时unset无用变量,尤其是PHP5.2上。

5.6. [强制]对于一些系统操作,使用php内置的函数例如rename、touch等即可。尽量避免使用exec调用shell命令。

5.7. [建议]除非特殊情况,否则不允许使用require和include,而使用对应的require_once/include_once。

5.8. [建议]配置项与PHP代码分离,不随CVS/SVN发布

5.9. [强制]预定义变量一律使用短格式,即:$_POST、$_GET、$_SERVER、$_ENV等,不再使用长格式:$_HTTP_POST_VARS、$_HTTP_GET_VARS。

5.10. [强制]类文件名必须符合所用框架自动加载规范,常见的是PSR-0。

5.11. [建议]除模板外,尽量不要在php代码中出现html标签。

5.12. [建议]能用foreach的就不要用for,能用for的就不要用while。

5.13. [强制]每个前端访问请求必须有且仅有一条notice日志。

5.14. [建议]数据库写操作必须有日志记录;记录条数应与操作一一对应。

5.15. [强制]文件更新操作,必须使用临时文件+mv的方式,切忌直接写在原文件。

5.16. [建议]字符串尽量用’ ‘而不是” “进行引用,一个是效率问题,一个是安全问题。

5.17. [强制] [PHP031] 所有的define语句,常量必须用’‘包括起来。

5.18. [建议]require/include后面不使用括号。

5.19. [强制] [PHP020] 函数允许使用默认参数,但是默认参数需要放到参数列表最后面。

5.20. [强制] [PHP032] 所有的全局变量应该写在函数的最开头,并且和后面的代码以空行隔开。

5.21. [强制] [PHP033] 禁止使用and, or, 而是使用&&, ||

5.22. [建议]避免使用$i, $j这样无意义的变量名, 除非是用作循环计数变量。

5.23. [建议]避免使用php逻辑代码作为配置, 以降低改配置的危险性。

5.24. [建议]进行==判断时,建议把常量放在前面, 避免误写成赋值操作。

5.25. [建议]使用变量前赋初值,提高可读性,也可避免误用别处定义的同名变量。

5.26. [建议]错误码使用统一文件集中配置,并且使用常量,而不应裸写数字

5.27. [建议]对于无需子类化的实体类以及不应重载的方法使用final关键字限定。

5.28. [强制]对于不应实例化的父类使用abstract关键字限定。

5.29. [建议]避免重载父类的static成员,这在5.2.x存在问题。

5.30. [建议]对于仅用于某个函数或类的全局变量,使用static的局部变量或者类成员变量代替。

5.31. [建议]在头文件中用$GLOBALS定义全局变量,避免局部包含导致的作用域问题。

6. 代码性能

6.1. [强制] [PHP034] 把重复调用放在循环体外。

 

posted @ 2021-09-13 22:07  Don--  阅读(423)  评论(0编辑  收藏  举报