编码的规范和建议.docVIP

目 录 第1章 文件结构 3 1-1 共性规则 3 1-2 头文件 3 第2章 程序的版式 4 2-1 空行 4 2-2 代码行 4 2-3 代码行内的空格 5 2-4 对齐 6 2-5 长行拆分 6 2-6 注释 7 2-7 类的版式 7 第3章 命名规则 8 3-1 共性规则 8 3-2 简单的Windows应用程序命名规则 9 3-3 常见前后缀 9 第4章 表达式和常量 12 4-1 表达式 12 4-2 常量 12 第5章 函数设计 13 5-1 参数的规则 13 5-2 返回值的规则 13 5-3 函数内部实现的规则 14 5-4 其它建议 15 5-5 使用断言 15 第6章 程序界面设计规范 15 6-1 颜色选择 15 6-2 字体的选择 15 6-3 图片的选择 15 6-4 操作的便利性 16 6-5 数据安全 16 6-6 帮助文件 16 6-7 窗体大小的确定 16 6-8 操作进度指示 17 6-9 分隔线控件 17 第7章 其它编程经验 17 7-1 使用const提高函数的健壮性 17 7-2 提高程序的效率 17 7-3 为多语言版做准备 18 7-4 一些有益的建议 18 第8章 公司员工建议 18 规范严重程度分为四种 0、 黄色突出标识：要罚款 红色标识:是特别严重 天蓝色标识:一定要遵守 蓝色标识:推荐遵守 同时被黄色底色和颜色标识的，按黄色底色处理。 奖罚制度:（新的） 对违反各级规定的，都要进行检讨，对违反黄色底色标识的要被罚款，每违反一条罚5元，每再违反一次多加一元，比如违反两次罚6元，违反三次罚7元，依此类推。 奖罚制度:（以前的） 一阶级: 2008-05-192008-05-24 通报不符合规范代码。同时贴于内部网 二阶段; 2008-05-24 方案1：代码规范奖罚,一次：1级:5元 2级:2元(一处错误算一次 ,修改时间一个工作日,上限不超过等级*5%)；公司设立代码规范奖金池(由罚金构成)，奖池全额做为开发部集体活动经费，由开发部支配. 罚款超过等级*30%者将面临辞退。 希望大家重视，如2008-07-24以后出现开发部总罚金超过开发部总等级*5%的现象，罚金不设上限。 测试人员负责代码规范审查。开发部部不定期组织代码审查。 文件结构 共性规则 按照目的组织文件的内容，相同目的的内容组织在一起。头文件包含声明排在类、变量、函数声明或定义之前。 用 #include filename.h 格式来引用标准库的头文件，用 #include “filename.h” 格式来引用非标准库的头文件。 头文件 为了防止头文件被重复引用，应当用pragma once或ifndef/define/endif结构产生预处理块。 头文件中只存放“声明”而不存放“定义” 程序的版式 空行 在每个类声明之后、每个函数定义结束之后都要加空行。 在一个函数体内，逻揖上密切相关的语句之间不加空行，其它地方应加空行分隔。 // 空行 void Function1(…) { … } // 空行 void Function2(…) { … } // 空行 void Function3(…) { … } // 空行 while (condition) { statement1; // 空行 if (condition) { statement2; } else { statement3; } // 空行 statement4; } 示例2-1(a) 函数之间的空行 示例2-1(b) 函数内部的空行 代码行 一行代码只做一件事情。如只定义一个变量，或只写一条语句。这样的代码容易阅读，并且方便于写注释。 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(); for (initialization; condition; update) { dosomething(); } // 空行 other();