事业一部编程规范程序风格.docVIP

强制编程规范 2012-6-29 V1.01 目录 第1章 前 言 1 第2章 程序的版式 2 2.1 空行 2 2.2 代码行 3 2.3 代码行内的空格 3 2.4 对齐 4 2.5 长行拆分 6 2.6 修饰符的位置 7 第3章 表达式和基本语句 8 3.1 运算符的优先级 8 3.2 复合表达式 9 3.4 for 语句的循环控制变量 9 3.5 switch语句 9 第4章 常量 11 4.1 为什么需要常量 11 第5章 注释 12 第6章 命名 13 6.1 变量名的命名规则 13 5.2 变量命名要求 14 6.3 函数的命名规范 14 6.3.1 函数名 14 6.3.2 函数参数规范 14 第7章 文件结构 15 7.1 头文件结构 15 7.2 源文件结构 16 第8章 其他 19 第1章 前 言 每位工程师写程序的习惯和风格都不同，原本也没有什么对错，但我们是研发团队，绝对不能任由乱七八糟的程序代码充斥在系统中。正确性，可读性和可维护性一样重要，否则，当某个艺术派软件工程师离职后，恐怕没有人具有一样的慧根可以改动他的程序。所以在开发团队中，所有的软件工程师都必需遵守程序风格典范文件。所谓的程序风格，不仅是命名规格，还规范了程序代码中至少应该具有哪些信息，以及程序编写的注意事项。 此篇程序设计规范，用来规范现在的程序写作。希望通过此规范提高程序的可移植性与重复使用性，最重要的是提高我们程序写作的可读性，并且可以将好的程序设计思想，以及技术进行传承。同时我们可以根据此标准检查程序编写员编写的程序是否满足要求，也是新员工以后学习的资料。 为了尽快规范程序员的编程习惯，我们将逐步实施强制编程规范，第一步先实施那些简单、必须、易执行的一些规范。这个规范中用红色字体标识的【强制规则】是必须遵守的规范。 第2章 程序的版式 版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。 可以把程序的版式比喻为“书法”。好的“书法”可让人对程序一目了然，看得兴致勃勃。差的程序“书法”如螃蟹爬行，让人看得索然无味，更令维护者烦恼有加。请程序员们学习程序的“书法”，弥补大学计算机教育的漏洞，实在很有必要。 2.1 空行 空行起着分隔程序段落的作用。空行得体（不过多也不过少）将使程序的布局更加清晰。空行不会浪费内存，虽然打印含有空行的程序是会多消耗一些纸张，但是值得。所以不要舍不得用空行。 ????????? 【强制规则2-1-1】在每个函数定义结束之后都要加空行。参见示例2-1（a） ????????? 【强制规则2-1-2】在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。参见示例2-1（b ） ? // 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … } ? // 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } 示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行 ? 2.2 代码行 ????????? 【强制规则2-2-1】一行代码只做一件事情，如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 ????????? 【强制规则2-2-2】if、for、while、do等语句自占一行，执行语句不得紧跟其后。 ? 示例2-2（a）为风格良好的代码行，示例2-2（b）为风格不良的代码行。 ? ? int width; // 宽度 int height; // 高度 int depth; // 深度 ? int width, height, depth; // 宽度高度深度 ? x = a + b; y = c + d; z = e + f; X ＝ a + b; y = c + d; z = e + f; ? if (width height) { dosomething(); } if (width height) dosomething(); 示例2-2(a) 风格良好的代码行 示例2-2(b) 风格不良的代码行 ? ???????? 【建议2-2-1】尽可能在定义变量的同时初始化该变量（就近原则） 如果变量的引用处和其定义处相隔比较远，变量的初始化很容易被忘记。如果引用了未被初始化的变量，可能会导致