原创 aquasnake之编程规范

一、目的：为统一程序撰写风格与便于代码理解，并减少调试时间，特制定此规范。

二、规范细则：

1.文件名
  只有字母、下划线和数字的字符串。

2.文件标识
  对应文件名，全部大写，把.替换成_，两边各加__。如文件名是：A.h，则文件标识是：__A_H__。

3.全局变量
  只有字母和数字的字符串，开头字符必须是字母。首字母大写，缩略词大写。

4.常量与宏定义
  只有字母、下划线和数字的字符串。开头字符必须是字母或下划线。全部大写。

5.自定义类型
  只有字母、下划线和数字的字符串。开头字符必须是字母或下划线。全部大写。

6.函数
  函数名是只有字母和数字的字符串，开头字符必须是字母。首字母大写，缩略词大写。  形式参数与函数体内局
部变量必须是只有字母和数字的字符串，开头字符必须是字母。全部小写。

7.缩进格式
  采用Tab键缩进，一次缩进一Tab格度。

8.大括号{}
  总是位于行首，独立占有一行。同一级别的{、}缩进对称。

9.算术、逻辑、赋值运算符
  两边各空一格空白键。

10.条件编译语句
  顶格写，不能缩进。

11.注释
  用/*，*/符号，中间插入注释，注释尽量用英文。

12.屏蔽未用代码
  单独一行用//符号，若多行则使用/*，*/符号。//，/*，*/必须顶格写，不能缩进；/*，*/必须单独占有一行。
不建议用if(0)，会增加代码长度。

13.文件包含
  c文件可以包含c文件与h文件，h文件只能包含h文件,尽量把include写到c文件中。包含编译器库文件用<...>，
包含工程文件用"..."。

14.避免重复定义  
   参考文件标识，在h文件中写条件编译  
   #ifndef __*_H__  
   #define __*_H__  
   ...  
   #eddif
  （*代表通配符，具体根据文件名定）

15.C++兼容
  在需要兼容的代码段外定义：
  #ifdef __cplusplus
  extern "C" {
  #endif
  ...
  #ifdef __cplusplus
  }  #endif
=======================================================
未明确部分待补