软件项目编程规范

1. 每个文件级模块必须编写一个说明，模块说明要求以注释的形式出现在模块的首部，要写清楚该模块的功能，并写明编写人及编写时间（为了以后系统整合时交流方便一些）；

2. 对于每一个函数都应给出函数说明，描述其函数功能、参数说明以及返回值说明，如果是修改别人的文件，应写明编写人及修改时间； 

3. 头文件书写规范

头文件应该按固定的顺序编写，首先使用 #include包含语句编写本头文件中需要包含的其他头文件，其次声明函数原型，接着定义用到的数据常量。定义数据常量使用#define语句，并且使用#ifndef/#define/#endif宏来防止重复定义，方便各模块之间相互调用。

4. 变量命名

  变量的命名应该能够反映变量的数据类型和含义，采用英文命名，最好能做到见名知意。命名必须具有一定的实际意义。

  常量的命名：全部用大写。

  变量的命名：变量名加前缀，前缀反映变量的数据类型，用小写；反映变量意义的第一个字母大写，其他小写。

  函数的命名：函数名首字母大写，若包含有两个单词的，则每个单词首字母大写。函数原型说明包括引用外部函数及内部函数，外部引用必须在右侧注明函数来源(模块名及文件名)。

5. 注释

  可以采用/* */和//进行注释；

  注释写在代码的上方或者右方，千万不要写在下方；

  对重要变量说明其作用；

  对每一段函数代码加注释说明功能；

  对重要的语句加注释说明其功能；

  对重要的函数调用的参数加实际参数说明；

  在自己认为必要的地方加上注释。 

6. 书写规范

  缩进：书写代码时要注意括号对齐，固定缩进。根据语句间的层次关系采用缩进格式书写程序，每进一层，往后缩进一层。缩进以 Tab 为单位，一个 Tab 为4个空格大小。

  一个{ }各占一行，if/for/while/do等语句各占一行，执行语句不得紧跟其后。

  一行只实现一个功能，不要在一行写多条语句。

  不管有没有无效分支，switch函数一定要default这个分支。一来让阅读者知道程序员并没有遗忘default，并且防止程序运行过程中出现的意外(健壮性)。

  指针说明符与前面的类型之间加空格，与变量名之间不要加空格。

7、编程时，对于一些固定的常量以及常需要在调试时修改的参数最好用 #define定义，但要注意宏定义只是简单的替换，因此有些括号不可少。