双人项目代码规范

老师在课上给出了两本参考教材,分别是《Java开发手册》和《华为编码规范(C语言版)》,我简略的看了一下两本教材,私认为《华为编码规范(C语言版)》对我的帮助更大一点。因此我主要围绕《华为编码规范(C语言版)》并结合课上老师介绍的代码规范九条,尽量达到简明易懂无歧义。

1、在本次和安仲政的双人项目中,对齐只使用空格健,并且规定缩进的空格数为4.避免不同编辑器使用tab键造成缩进不一致的情况。

2、对行宽进行控制,当循环或者判断等语句过长时,进行划分,操作数放在新行句首并且在低优先级出划分新行,

3、使用括号明确操作顺序,避免程序自动使用默认顺序,并防止程序员在阅读程序时产生误解。并巧妙利用括号设计元素布局与排列,使结构对于阅读的人来说易于理解。

4、对于空行和空白的{}行,相对的程序块之间加空行,并且if,for,do,while,case,switch等语句独占一行并且无论执行语句多少必须加{},且{}各独占一行。注释于上面的代码用空行隔开。

5、一行只写一个短语,并且将过长的函数或者过程进行划分,当语句大于100字符时,要分成多行书写,在低优先级出划分,并且要使用空格缩进,排版整齐。

6、命名必须清晰,明确,缩写或事先约定的命名在源文件处注释说明,且风格保持一致,切勿变化。

7,注意下划线_的使用,本项目规定_只用在分割变量作用域的标注和变量的语义,其他方面不使用。

8,用大小写的字母顺续规范函数,变量名,函数名第一个单词的第一个字母大写,后面的单词小写,变量名第一个单词的首字母小写,第二个单词首字母大写随后的单词小写。

9、注释要充分,避免遗忘。说明性文件头部进行注释,表明作者日期,函数功能等,注释要清楚明确,避免在注释中使用缩写。并且注意注释的位置,放于注释代码的上方或者右方,如果放在上方要与注释上方的代码隔开。对于变量名如果缩写,要注意注释清楚。

这是关于代码规范九条的内容,除此之外,我还想补充几点

10、函数的功能要单一,最好一个函数一个功能,便于调用和测试,简单功能也要编写函数,便于维护。函数是可控制预测的。

posted @ 2020-10-18 20:23  哎一咕光洙啊  阅读(66)  评论(0)    收藏  举报