C编程规范整理

小锋学长生活大爆炸

发布于 2020-10-29 11:11:11

8230

发布于 2020-10-29 11:11:11

文章被收录于专栏：小锋学长生活大爆炸

只有当函数只有10行甚至更少时才会将其定义为内联函数（inline function)。当函数体比较小的时候，内联该函数可以令目标代码更加高效。内联那些包含循环或switch语句的函数是得不偿失的。如果一个inline函数会在多个源文件中被用到，那么必须把它定义在**.h头文件**中。
定义函数时，参数顺序为：输入参数在前，输出参数在后。这一点并不是必须遵循的规则，输入/输出两用参数（通常是类/结构体变量）混在其中，会使得规则难以遵循。
包含文件的名称及次序：C库、C++库、其他库的.h、项目内的.h。
编写短小函数。长函数有时是恰当的，因此对于函数长度并没有严格限制。如果函数超过40行，可以考虑在不影响程序结构的情况下将其分割一下。
const使用。强烈建议你在任何可以使用的情况下都要使用const。
类型命名。类型命名每个单词以大写字母开头，不包含下划线：MyExcitingClass、MyExcitingEnumo。所有类型命名——类、结构体、类型定义（typedef)、枚举——使用相同约定。
变量命名。变量名一律小写，单词间以下划线相连，类的成员变量以下划线结尾，如my_exciting_local_variab1e、my_exciting_meber_variab1e_。
全局变量。可以以 g_ 或其他易与局部变量区分的标志为前缀。
普通函数。大小写混合，函数名以大写字母开头，每个单词首字母大写，没有下划线：AddTab1eEntry()、DeleteUr1()。
存取函数。存取函数要与存取的变量名匹配：set_my_exciting_member_variab1e() 。
其他短小的内联函数名也可以使用小写字母，例如，在循环中调用这样的函数甚至都不需要缓存其值，小写命名就可以接受。
枚举命名。枚举值应全部大写，单词间以下划线相连：MY_EXCITING_ENUM_VALUE。枚举名称属于类型，因此大小写混合：Ur1Tab1eErrors。
宏命名。其命名像枚举命名—样全部大写、使用下划线。
注意永远不要用自然语言翻译代码作为注释，要假设读你代码的人C/C++比你强。
TODO注释。对那些临时的、短期的解决方案，或已经够好但并不完美的代码使用TODO注释。后面括号里加上你的大名、邮件地址等，还可以加上冒号：，目的是可以根据统一的TODO格式进行查找:
全局变量要有较详细的注释，包括对其功能、取值范围以及存取时注意事项等的说明。
注释应放在其代码上方相邻位置或右方，不可放在下面。如放于上方则需与其上面的代码用空行隔开，且与下方代码缩进相同。
对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。
避免在注释中使用缩写，除非是业界通用或子系统内标准化的缩写。
注释应考虑程序易读及外观排版的因紊，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。对于有外籍员工的，由产品确定注释语言。
文件头、函数头、全局常量变量、类型定义的注释格式采用工具可识别的格式（如doxygen）。