嵌入式C语言编码规范要点

1.函数命名方法

  骆驼命名法（Camel）

  帕斯卡命名法（（pascal），也叫大驼峰命名法（Upper Camel Case）

  匈牙利命名法

  下划线命名法（也称为蛇形命名法）

  详述见之前文章：四种编程命名规则介绍

  https://blog.csdn.net/xieliru/article/details/139481164?spm=1001.2014.3001.5501

2.注释

（1）最好符合doxygen样式。

     注释允许使用 (/* comments */) 或 (// comments) 式样。

（2）文件头注释

/** @fileexample.c

 * @brief Example of C implementation file

 * @authorAuthor of creation

 * @dateDate of creation

 * @details This file contains an example layout of C implementation file.

 */

3.缩进和格式化

  行首使用四个空格缩进（或者是tab键，但要确认tab键是4个空格）对齐，其他地方通常使用空格保持对齐，而不是tab。

4.文件及函数长度

  每个文件包含注释或空行的行数不超过2000行。

  每个函数包含注释或空行的行数不超过200行。

  每行内容不超过120个字符。

  

5.宏定义及变量使用

  魔数(数字或字符串) 不得出现在代码中，而是通过宏定义或常量来替代。

  所有的变量在使用之前必须初始化。

    

6.指针使用

  指针在使用之前要检查是否为空，同时如果内存释放了，指针要被设置成NULL。

  函数原型中的指针参数如果不是用于修改就必须声明为指向const的指针。

7.其他

  尽量不使用goto语句和标号。  

  

  宜用括号“()”明确表达式的操作顺序,避免使用默认优先级。

  

  不宜在循环中使用continue和break语句。  

  

  应禁止签名类型与无签名类型之间的隐式转化。

  注:从有符号类型转换为无符号类型会导致符号的丢失;无符号数转换为有符号数时,可能得到一个负值

  

  不应对有符号数进行位运算。

  数组的索引值不应越界。

   

  不应对浮点类型变量使用“=-”和“!=”作比较