软件部编程规范(C#版).docVIP

北京云星宇研发中心软件部 软件开发编码规范 编号： 版本：V0.2 编写： 2010年2月 审核： 年 月 日 批准： 年 月 日  文件档案表 编号 名称 湖南省高速公路MTC收费系统需求规格说明书(车道子系统) 页数 版本 V0.1 与文档相关的文件位置（URL） 设计 编写 QA审核/校验 评审 批准 责任人 日期 所属机构 安全保密级别 普通 秘密 ★ 机密 高级机密 备注 修改记录 日期 版本号 内容摘要 作者 2010/01/21 0.1 初稿 赵阳 2010/01/27 0.2 增加修改注释规范，修改控件命名规范 刘刚 2010/01/26 0.3 根据评审会议，删减部分指南，对代码修改规范进行较严格要求 赵阳  C#编程规范 目录 1前言 4 1.1 编写目的 4 1.2 范围 4 1.3命名规范 4 1.4程序开发规范 4 1.4.1表达式和基本语句 4 1.4.2函数设计 5 1.4.3资源管理 5 2. 规范内容详解 5 2.1 代码格式 5 2.2 命名指南 6 2.2.1 大写样式 6 2.2.2 区分大小写 7 2.2.3 缩写 8 2.2.4 措词 9 2.2.5 避免类型名称混淆 10 2.2.6 命名空间命名指南 11 2.2.7 类命名指南 12 2.2.8 接口命名指南 13 2.2.9 枚举类型命名指南 13 2.2.10 静态字段命名指南 14 2.2.11 参数命名指南 14 2.2.12 方法命名指南 14 2.2.13 属性命名指南 15 2.2.14事件命名指南 16 2.2.15控件命名指南 17 2.2.16数据库命名 18 2.3??? 注释（Comment）规范 18 2.3.1 模块（类）注释规范 18 2.3.2 类属性注释规范 19 2.3.3 方法注释规范 19 2.3.4 代码间注释规范 19 2.3.5 代码修改注释规范 20 3 成功的模式 20 3.1 有效地使用这些标准 20 3.2 其它导向成功代码的因素 21 1前言 1.1 编写目的 为了保证企业编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。 1.2 范围 适用于企业所有基于.NET平台的软件开发工作。 1.3命名规范 【1.3.1】不要追求世界上最好的命名规则！在机构内部一致即可。 【1.3.2】直观并且可以拼读，可望文知意，不必“解码”。 【1.3.3】名字的长度：min-length max-information 原则 【1.3.4】与操作系统和开发工具的风格保持一致 【1.3.5】程序中不要出现仅靠大小写区分的相似的标识符 【1.3.6】程序中不要出现标识符完全相同的局部变量和全局变量 【1.3.7】变量的名字应当使用“名词”或者“形容词＋名词” 【1.3.8】全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。 【1.3.9】用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 【1.3.10】尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号 1.4程序开发规范 1.4.1表达式和基本语句 【1.4.1.1】如果代码行中的运算符比较多，用括号确定表达式的操作顺序，避免使用默认的优先级。 【1.4.1.2】不要编写太复杂的复合表达式。 不要把程序中的复合表达式与“真正的数学表达式”混淆。 【1.4.1.3】如果循环体内存在逻辑判断，并且循环次数很大，宜将逻辑判断移到循环体的外面。 【1.4.1.3】建议for语句的循环控制变量的取值采用“半开半闭区间”写法。 1.4.2函数设计 【1.4.2.1】参数的书写要完整，不要贪图省事只写参数的类型而省略参数名字。 【1.4.2.2】参数命名要恰当，顺序要合理。 【1.4.2.3】建议避免函数有太多的参数，参数个数尽量控制在5个以内。 【1.4.2.4】尽量不要使用类型和数目不确定的参数。 【1.4.2.5】函数名字与返回值类型在语义上不可冲突。 【1.4.2.6】不要将正常值和错误标志混在一起返回。 【1.4.2.7】在函数体的“入口处”，对参数的有效性进行检查。 【1.4.2.8】在函数体的“出口处”，对return语句的正确性和效率进行检查。 【1.