Skip to content

C语言编码规范

1、注释

  • 注释要占整个代码的20%以上

  • 如果case事件不为空且结束时没有return或break则需要注释说明/*fall through*/

  • 当代码比较长且有多重嵌套时应在段落结束处加注释

  • 每一条宏定义右边必须有注释

2、命名

  • 变量名全部小写,多个单词用下划线连接,如my_variable,函数名也是如此,具体规范应参考代码的其它部分风格一致

  • 变量声明时一个变量写一行,例如:

c
int a = 1;
int b = 2;

3、空格&缩进&空行

  • 缩进:缩进统一使用tab键

  • 空格:关键字后,ifforwhile后,运算符前后,,之后,如果;不是一行的结束则在后面加空格

  • 空行:定义变量后,函数定义结束后 ,独立语句前后,return前

4、代码块

  • {}必须独占一行且位于同一列

  • ifforwhile等语句尽管只有一行代码,但也要加上{}

5、函数

  • 每个有返回值的函数必须做返回值检查

  • 函数体不能超过100行

其它

  • 统一使用UTF-8编码

  • 一行的字符数不能超过120

  • 条件判断==和!=遵循左值原则,左边为常量

  • 慎用少用malloc,用完记得free()

WARNING

warning必须解决,编译时添加-Werror将warning视为error处理

Released under the MIT License.