2014程序编程规.docxVIP

磁力仪程序的编程规范1：排版2：注释 3：标识符命名4：可读性 5：变量、结构 6：函数、过程 7：程序效率 8：代码测试、维护1 排版1-1：程序块要采用缩进风格编写，缩进的空格数为4 个。相对独立的程序块之间、变量说明之后必须加空行。示例：应如下书写if (!key){... // program code}//空格program code1-2：不允许把多个短语句写在一行中，即一行只写一条语句。示例：如下例子不符合规范。i = 0; j = 0;应如下书写i = 0;j = 0;1-3：if、for、do、while、case、switch、default 等语句自占一行，且if、for、do、while等语句的执行语句部分无论多少都要加括号{}。示例：如下例子不符合规范。if (i == 0) return;应如下书写：if (i == 0){return;}1-4：函数或过程的开始、结构的定义及循环、判断等语句中的代码都要采用缩进风格，case语句下的情况处理语句也要遵从语句缩进要求。1-5：程序块的分界符（如C/C++语言的大括号‘{’和‘}’）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类的定义、结构的定义、枚举的定义以及if、for、do、while、switch、case 语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for (...) {... // program code}应如下书写。for (...){... // program code}1-6：一行程序以小于80 字符为宜，不要写得过长。2 注释2-1：一般情况下，源程序有效注释量必须在20％以上。说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁。2-2：文件头部应进行注释，注释必须列出：版权说明、版本号、生成日期、作者、内容、功能、修改日志等。示例：下面这段头文件的头注释比较标准。/*****************************************************************************Copyright:2012-2013，jlu，447File name: 文件名Description: 用于详细说明此程序文件完成的主要功能，与其他模块或函数的接口，输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系Author: 作者Version: 版本Date: 完成日期History: 修改历史记录列表， 每条修改记录应包括修改日期、修改者及修改内容简述。*****************************************************************************/2-3：函数头部应进行注释，列出：函数的目的/功能、输入参数、输出参数、返回值、调用关系（函数、表）等。示例：下面这段函数的注释比较标准，当然，并不局限于此格式，但上述信息建议要包含在内。/*************************************************Function: // 函数名称Description: // 函数功能、性能等的描述Calls: // 被本函数调用的函数清单Called By: // 调用本函数的函数清单Input: // 输入参数说明，包括每个参数的作// 用、取值说明及参数间关系。Output: // 对输出参数的说明。Return: // 函数返回值的说明Others: // 其它说明*************************************************/2-4：边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2-5：注释的内容要清楚、明了，含义准确，防止注释二义性。说明：错误的注释不但无益反而有害。2-6：注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则需与其上面的代码用空行隔开。应如下书写program code//空格隔开/*注释 */program code 2-7：对于所有有物理含义的变量、常量，如果其命名不是充分自注释的，在声明时都必须加以注释，说明其物理含义。变量、常量的注释应放在其上方相邻位置或右方。示例：/* active statistic task number */#define MAX _NUMBER 1000#define MAX _NUMBER 1000 /* active statistic task number */2-8：局变量要有较详细的注释，包