双人项目的编码规范

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

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

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

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

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

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

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

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

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

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

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

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

posted @ 2020-10-18 20:15  白鸥问我  阅读(76)  评论(0)    收藏  举报