华为代码规范小记（c）_华为代码cbb

一、标识符命名与定义

1、标识符的命名要清晰、明确，使用完整的单词或者大家可以理解的缩写，方便理解和避免产生误解。

2、除了常见的通用缩写之外，其他单词不得缩写，也不能使用中文拼音、

3、命名要与所在项目组保持一样的风格。

4、使用正确的反义词来命名具有互斥意义的变量或者相反动作的函数。

5、尽量避免名字中出现编号，除非在逻辑上需要。

6、标识符前不应该加项目、部门名称等作为前缀，否则变动很麻烦。

7、文件命名统一用小写字符。全局变量应该加g_ , 静态变量应该加s_ 。

8、禁止使用单字符命名，但可以使用ijk作为局部变量。

9、对于有些经常使用的字母或者数字进行定义，建议采用全大写字母，单词之间加下划线。

10、除了头文件和编译文件等特殊标识定义，宏定义不能使用下划线作为开头和结尾。

二、变量

1、一个变量只能有一个功能，不能把一个变量用作多种途径。

2、不用或者少用全局变量，单个文件内部可以使用static的全局变量。

3、防止局部变量和全局变量同名。

4、明确全局变量的初始化顺序，尽量减少没有必要的数据类型转换。

三、表达式

1、确保表达式的值在任何允许的标准运算次序下都是相同的。

2、函数调用不要作为另外一个函数的参数使用。

3、赋值语句不要写在if语句中或者作为函数的参数使用。

4、用括号明确好表达式的操作顺序，避免过分依赖原优先级。

四、注释

1、优秀的代码可以自我解释，不需要注释也可以读懂。

2、注释的内容要清楚明确、不能有歧义。

3、注释应当描述代码无法展示出来的部分，而不是简单重复描述代码。

5、如果后期维护代码时对代码有所修改，若注释内容也需修改应当修改，不再有用的注释的删除。

6、文件头部应当进行注释，注释功能必须列出：版权说明、版本号、生成日期、作者姓名、工号、内容、功能说明、与其他文件的关系、修改日志，头文件的注释还应当有函数功能的简要说明。

7、函数声明处注释描述函数的功能、性能及其用法，包括输入和输出参数、函数返回值、可重入的要求等；定义处详细描述函数功能和实现要点，如实现的简要步骤、实现的理由、设计约束等。

8、全局变量要有较为详细的注释，包括对其功能、取值范围以及存取时注意事项等说明。

9、注释应当放在代码上方或者右方，且与下方代码缩进相同，如果位于上方要与代码隔一个空行；不可以在下方。

10、对于Switch语句下的case语句，在该case处理完，下一个case语句前加上明确的注释。

11、避免在注释中使用缩写，避免在一行代码或表达式中间插入代码，统一项目统一注释风格。

12、文件头、函数头、全局常量变量、类型定义的注释格式采用工具可识别的格式。

五、排版与格式

1、程序块采用缩进风格，一个缩进四个空格。

2、相对独立的程序块之间要加空行。

3、短语句不能堆积在一行写，意思是一行只能有一句代码。一条语句也不能过长。

4、if 、 for 、 do  、while 、 case 、 Switch 、 default等语句独占一行。

一般在后面加上{}，对于if来说，{ 可以跟在后面也可以独立占一行，一般如果代码语句过长并且涉及换行则建议{}独占一行，独占一行可以与if同缩进，也可以是下一行缩进。

5、采用松散方式编写代码，在两个以上的关键字、变量、常量进行对等操作时，他们之间的操作符应当加上空格。进行非对等操作，如果是关系密切的操作符，如->>，则不需要加空格。例如，逗号和分号只在后面加空格。比较操作符、赋值操作符前后加空格。！ ~  ++  --  &等单目操作符（地址操作符）前后不加空格。指针（->）前后不加空格。if、for、while、Switch语句与后面的括号应该加空格，使得她们更加突出。

6、注释符与注释内容之间要隔一个空格。

7、源程序中关系较为紧密的代码尽量相邻。