所在的位置: php >> php优势 >> 编程规范都有哪些要求

编程规范都有哪些要求

编程规范化是每一个程序员在学习编程开发技术的时候都会要求遵守的一个规范,而今天我们就通过案例分析来了解一下,编程规范都有哪些要求。

(1)命名

以能准确达意为目标,利用上下文简化命名,命名要可读、可搜索。

对于接口的命名,一种是加前缀“I”,另一种是加后缀“Impl”;对于抽象类的命名,一种是带上前缀“Abstract”,另一种是不带前缀。

(2)注释

注释的内容主要包含这样四个方面:做什么、为什么、怎么做、怎么用。对一些边界条件、特殊情况进行说明,以及对函数输入、输出、异常进行说明。

写一些总结性的说明、特殊情况的说明。对于逻辑比较复杂的代码或者比较长的函数,借助总结性的注释来让代码结构更清晰、更有条理。

类和函数一定要写注释,而且要写得尽可能全面、详细,而函数内部的注释要相对少一些,一般都是靠好的命名、提炼函数、解释性变量、总结性注释来提高代码的可读性。

(3)类、函数规模

当一个类的代码读起来让你感觉头大了,实现某个功能时不知道该用哪个函数了,想用哪个函数翻半天都找不到了,只用到一个小功能要引入整个类(类中包含很多无关此功能实现的函数)的时候,这就说明类的行数过多了。

对于函数代码行数的大限制,网上有一种说法,那就是不要超过一个显示屏的垂直高度。

(4)一行代码的长度

一行代码长不能超过IDE显示的宽度。需要滚动鼠标才能查看一行的全部代码,显然不利于代码的阅读。

(5)善用空行分割单元块

在类的成员变量与函数之间、静态成员变量与普通成员变量之间、各函数之间、甚至各成员变量之间,都可以通过添加空行的方式,让这些不同模块的代码之间,界限更加明确。

(6)缩进

Java语言倾向于两格缩进,PHP语言倾向于四格缩进。

(7)大括号是否要另起一行

PHP程序员喜欢另起一行,Java程序员喜欢跟上一条语句放到一起。

(8)类中成员的排列顺序

在Java类文件中,先要书写类所属的包名,然后再罗列import引入的依赖类。在Google编码规范中,依赖类按照字母顺序从小到大排列。

在类中,成员变量排在函数的前面。成员变量之间或函数之间,都是按照“先静态(静态函数或静态成员变量)、后普通(非静态函数或非静态成员变量)”的方式来排列的。

成员变量之间或函数之间,还会按照作用域范围从大到小的顺序来排列,先写public成员变量或函数,然后是protected的,后是private的。

(9)把代码分割成更小的单元块

要有模块化和抽象思维,善于将大块的复杂逻辑提炼成类或者函数,屏蔽掉细节,让阅读代码的人不至于迷失在细节中。

(10)避免函数参数过多

函数包含3、4个参数的时候还是能接受的。针对参数过多的情况,一般有2种处理方法。

a、考虑函数是否职责单一,是否能通过拆分成多个函数的方式来减少参数。

b、将函数的参数封装成对象。

(11)勿用函数参数来控制逻辑

不要在函数中使用布尔类型的标识参数来控制内部逻辑,true的时候走这块逻辑,false的时候走另一块逻辑。

这明显违背了单一职责原则和接口隔离原则,建议将其拆成两个函数。

(12)函数设计要职责单一

相对于类和模块,函数的粒度比较小,代码行数少,所以在应用单一职责原则的时候,没有像应用到类或者模块那样模棱两可,能多单一就多单一。




转载请注明:http://www.aierlanlan.com/grrz/4934.html