代码规范参考华为篇

代码规范了解,参考CSDN中的代码规范华为篇

1、对所调用函数的错误返回要仔细、全面地处理

2、防止将函数的参数作为工作变量
(说明:将函数的参数作为工作变量,有可能错误地改变参数内容,所以很危险。对必须改变的参数,最好先用局部变量代之,最后再将该局部变量的内容赋给该参数。)

3、函数的规模尽量限制在 200 行以内     (说明:不包括注释和空格行。)

4、一个函数仅完成一件功能

5、为简单功能编写函数

(说明:虽然为仅用一两行就可完成的功能去编函数好象没有必要,但用函数可使功能明确,增加程序可读性,亦方便测试。)

6、不要设计多用途面面俱到的函数

(说明:多功能集于一身的函数,很可能使函数的理解、测试、维护等变得困难)

7、函数的功能应该是可以预测的,也就是只要输入数据相同就应产生同样的输出

8、尽量不要编写依赖于其他函数内部实现的函数

9、避免设计多参数函数,不使用的参数从接口中去掉

说明:目的减少函数间接口的复杂度。

10、非调度函数应减少或防止控制参数,尽量只使用数据参数

(说明:目的是防止函数间的控制耦合。调度函数是指根据输入的消息类型或控制命令,来启动相应的功能实体(即函数或过程),而本身并不完成具体功能。控制参数是指改变函数功能行为的参数,即函数要根据此参数来决定具体怎样工作。非调度函数的控制参数增加了函数间的控制耦合,很可能使函数间的耦合度增大,并使函数的功能不唯一。)

11、检查函数所有参数输入的有效性

12、检查函数所有非参数输入的有效性,如数据文件、公共变量等

说明:函数的输入主要有两种:一种是参数输入;另一种是全局变量、数据文件的输入,即非参数输入。

函数在使用输入之前,应进行必要的检查。

13、函数名应准确描述函数的功能,使用动宾词组为执行某操作的函数命名。如果是 OOP 方法,可以只有动词(名词是对象本身),避免使用无意义或含义不清的动词为函数命名

说明:避免用含义不清的动词如 process、handle 等为函数命名,因为这些动词并没有说明要具体做什么。

14、函数的返回值要清楚、明了,让使用者不容易忽视错误情况

说明:函数的每种出错返回值的意义要清晰、明了、准确,防止使用者误用、理解错误或忽视错误返回码。

15、不要把与函数返回值类型不同的变量,以编译系统默认的转换方式或强制的转换方式作为返回值返回

16、在调用函数填写参数时,应尽量减少没有必要的默认数据类型转换或强制数据类型转换,因为数据类型转换有风险。

17、防止把没有关联的语句放到一个函数中

说明:防止函数或过程内出现随机内聚。随机内聚是指将没有关联或关联很弱的语句放到同一个函数或过程中。随机内聚给函数或过程的维护、测试及以后的升级等造成了不便,同时也使函数或过程的功能不明确。

18、减少函数本身或函数间的递归调用
说明:递归调用特别是函数间的递归调用(如 A->B->C->A),影响程序的可理解性;递归调用一般都占用较多的系统资源(如栈空间);递归调用对程序的测试有一定影。

通过查阅资料了解到,我们平常的练习当中代码不规范的情况经常出现,要多关注这类的注意点,规范好代码的格式要求以及让代码更简便有效。

 

《数学之美》读后感作业链接:

https://www.cnblogs.com/Chris-hua4/p/15251490.html

posted @ 2021-09-10 15:31  赶鹭  阅读(353)  评论(0编辑  收藏  举报