1、1 IMS 软 件 编 程 规 范 论 文2009 - 2010 年度 第（一）学期论文名称 软件编程规范 班 级 学 号 学生姓名 指导教师 江兆银 完成日期 2009-12-22 扬 州 科 技 学 院 （ 筹 ）信 息 工 程 学 院IMS 软件编程规范22目录一、前言 3二、编程概述 3三、命名规范 4四、注释规范 5五、书写与排版规范 6六、编程质量规范 7七、参考文献 8IMS 软件编程规范33一、前言在当前软件行业迅猛的发展下，软件逐渐走向大型化。在这种软件走向大型化得形势下，一个软件需要众多的人参与。比如一个操作系统的开发需要上千人的工作。这样我们就不得不面临着如何管理。只要是
2、一个有用的软件就需要大量的工作，首先要进行软件需求分析，然后要设计出软件的框架，而实现软件的代码仅占很少一部分（约 20%） 。而你不要小看这代码的实现，也是要很多人的参与的，一般软件代码就有上千行，更别说操作系统了，据说 Linux 就有千万行的代码。这就需要把一个软件分成很多小的模块，分工完成。二、编程概述我们知道的，人与计算机的通信使用的是人工设计的语言，即程序设计语言。而编程目的就是把软件设计的结果翻译成计算机可以“理解”的形式用某种程序设计语言的结果书写的程序。编程作为软件工程的一个步骤，是软件设计的自然结果，程序的质量主要取决于软件设计的质量。但是，程序设计语言的特性和编程方法也会
3、对程序的可靠性、可读性、可测试性和可维护性产生深远的影响。所以这就要求我们不仅要选择合适的程序设计语言饿、 ，而且也体现了软件编程规范的重要性。1、程序员花更多的时间在调试、维护和升级已有代码上，而不是编写新的代码；2、程序最重要的是正确性，其次是可维护性，最后才是效率；3、学习如何写优美的程序与学习如何正确地编写代码同样重要；4、让程序尽量简单易懂，即使违背了某些规则也无关紧要；5、一个运行正常但没有注释的程序如同一个等待爆炸的定时炸弹，因为早晚会有人修改或升级这个程序；6、好风格应该成为一种习惯。如果你在开始写代码时就关心风格问题，如果你花时间去审视和改进它，你将会逐渐养成一种好的编程习惯
4、。一旦这种习惯变成自动的东西，你的潜意识就会帮你照料许多细节问题，甚至你在工作压力下写出的代码也会更好。IMS 软件编程规范44三、命名规范1. 变量名1.1 不同作用域变量的命名a. 局部变量以小写字母命名；b. 全局变量以首字母大写方式命名（骆驼式） ；c. 定义类型和宏定义常数以大写字母命名；d. 变量的作用域越大，它的名字所带有的信息就应该越多。局部变量： int student_age;全局变量： int StudentAge;宏定义常数：#define STUDENT_NUM 10 类型定义： typedef INT16S int;1.2 不同类型变量的命名（匈牙利命名法）匈牙利命
5、名法是一种命名约定。匈牙利命名法把变量的类型 (或者它的预期使用) 等信息编码在变量名中。一些常用的匈牙利命名法前缀数据类型 前缀 例子char c cInChar unsigned char uc ucOutChar int i iReturnValue unsigned int ui uiControlWord long l lNumRecs float f fLength double d dArea 1.3 指针变量的命名对于指针的定义，名称大小写根据指针为全局/局部变量来定，但指针名必须以小写的“p”开头。如：int *pDay; /全局指针int *pday; /局部指针int *
6、ppDay; /指针的指针1.4 在某一模块中使用的变量，变量名的开始需有模块名。如：模块 KEY.C 中的变量：int iKeyNum;int iKeyNumBuff10;2、常量 a、.定义常量的方法IMS 软件编程规范55（1）#define 宏定义（2）const 常量（3）enum 枚举2. const 常量如：const int MAX_STUDENT = 100;优点：const 常量有数据类型，而宏常量没有数据类型。编译器可以对前者进行类型安全检查。缺点： const 常量无法在数组定义时作为数组长度。如：float StudentHeightMAX_STUDENT; /错误3
7、 .枚举enumRED, BLUE, GREEN, YELLOW, WHITE, BLACK, COLOR_NUM;优点: (1) 适合一次定义批量常数，尤其是在数值连续时尤为方便；(2) 枚举常量可以作为数组长度，如：float BallSizeCOLOR_NUM;缺点：不能定义除整型外的其他类型常量，如 float 和 double。四、注释规范1 、 注释的基本概念C 语言的注释符为“/*/”。C+语言中，程序块的注释常采用“/*/”，行注（3）重要的代码行或段落提示。虽然注释有助于理解代码，但注意不可过多地使用注释。2 . 注释的准确性a .边写代码边注释，修改代码同时修改相应的注释，
8、以保证注释与代码的一致性。不再有用的注释要删除。b .注释应当准确、易懂，防止注释有二义性。错误的注释不但无益反而有害。c.尽量避免在注释中使用缩写，特别是不常用缩写。d .注释的位置应与被描述的代码相邻，可以放在代码的上方或右方，不可放在下方。3. 变量、常量的注释 a .对于所有物理含义的变量、常量，在定义和声明时都必须加以注释，说明其物理含义。变量、常量、宏的注释应放在其上方相邻位置或右方。 b.数据结构定义和声明(包括数组、结构、类、枚举等)，必须加以注释。对数据结构的注释应放在其上方相邻位置，不可放在下面；对结构中的每个成员的注释放在此成员的右方；同一结构中不同成员的注释要对齐。c.
9、全局变量要有较详细的注释，包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明IMS 软件编程规范66五、书写与排版规范1.6 用缩进格式书写代码a. 函数或过程的开始、结构定义及循环、判断等语句中的代码都要采用缩进；b. 缩进的空格数为 4 个；c. 使用空格键，不使用 TAB 键；d. 程序块的分界符（和）应各独占一行。例： for(i = 0; i 0) /遇到负分,记为 0分total_score += fScorei; 2 .其他书写格式2.1 长语句a . 较长的语句（多于 80 字符）要分成多行书写；b . 长表达式要在低优先级操作符处划分新行，操作符放在新行之
10、首；c . 划分出的新行要进行适当的缩进，使排版整齐，语句可读；d. 不允许把多个短语句写在一行中，即一行只写一条语句。 例：修改前： MeasData.TransTdir=TransTdir*SetData.Filter+TransTdir*(1-SetData.Filter); 修改后：MeasData.TransTdir = TransTdir * SetData.Filter + TransTdir * (1 - SetData.Filter); 2.2 空行和空格的使用a. 相对独立的程序块之间、变量定义之后语句开始以前必须加空行 ；b.逗号、分号只在后面加空格 ；c.比较操作符、赋
11、值操作符、算术操作符、逻辑操作符、位域操作符等双目操作符的前后加空格；d.“!”、 “”、 “+”、 “-”、 “ / 良好的风格void Func1 (int x,int y,int z); / 不良的风格x = a b ? a : b; / 良好的风格x=ab?a:b; / 不好的风格int *x = / 良好的风格int * x = / 不良的风格六、编程质量规范1、基本要求 a 、程序结构清析，简单易懂，单个函数的程序行数不得超过 100 行。 b、 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。 c、 尽量使用标准库函数和公共函数。 d、 不要随意定义全局变量，尽量使用局部变
12、量。 e、 使用括号以避免二义性。2、可读性要求：a、可读性第一，效率第二。b、保持注释与代码完全一致。 c、每个源程序文件，都有文件头说明，说明规格见规范。 d、每个函数，都有函数头说明，说明规格见规范。 e、 主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义。 f、常量定义（DEFINE）有相应说明。 g、 处理过程的每个阶段都有相关注释说明。 h、在典型算法前都有注释。3、 可重用性要求 ：a、 程序结构清析，简单易懂，单个函数的程序行数不得超过 100 行。b、 打算干什么，要简单，直接了当，代码精简，避免垃圾程序。c、 尽量使用标准库函数和公共函数。d、 不要随意定义全
13、局变量，尽量使用局部变量。IMS 软件编程规范88E、 使用括号以避免二义性。4. 结构化要求 a、 禁止出现两条等价的支路。 b、 禁止 GOTO 语句。c 、用 IF 语句来强调只执行两组语句中的一组。禁止 ELSE GOTO 和 ELSE RETURN。 d 、用 CASE 实现多路分支。 e 、避免从循环引出多个出口。 f 、函数只有一个出口。 g、 不使用条件赋值语句。 h 、避免不必要的分支。 i 、不要轻易用条件分支去替换逻辑表达式。 5. 正确性与容错性要求 a、程序首先是正确，其次是优美 b、无法证明你的程序没有错误，因此在编写完一段程序后，应先回头检查。c、改一个错误时可能产生新的错误，因此在修改前首先考虑对其它程序的影响。 d、 所有变量在调用前必须被初始化。 e、 对所有的用户输入，必须进行合法性检查。 f、 不要比较浮点数的相等， 如： 10.0 * 0.1 = 1.0 ， 不可靠 h 、程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否 逻辑锁定、打印机是否联机等。 i、 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。七、参考文献IMS 软件编程规范 ，南京大学出版社 编著 ：黄飞IMS 软件编程规范99
