软件开发代码要求规范(C#版).docx

文档编号 文档编号 版本 1.0 密级 本部门开放 工作规 共 15 页 软件开发代码规（C#版） 拟制: 日期： 审核: 日期： 审核: 日期： 批准: 日期： 所有 ******** 2007-2-13 修订纪录 日期 修订版本 描述 作者 2007-2-13 1.00 初稿完成 2007-5-10 1.01 修正 2007-11-2 1.02 修正 目 录 1、 第一章 命名规 4 、 第一节 总则 4 、第二节 变量命名规 4 、CodeBehind 部命名规 4 、控件命名规 5 、第三节 常量命名规 5 、第四节 命名空间、类、方法命名规 5 、第五节 接口命名规 6 、第六节 命名规小结 6 2、第二章 代码注释规 6 、第一节 模块级注释规（命名空间、类等） 6 、第二节 方法级注释规 7 、属性注释 7 、方法注释 7 、第三节 代码间注释规 8 3、第三章 编写规 9 、第一节 格式规 9 、第二节 编程规 9 、程序结构要求 9 、可读性要求 10 、结构化要求 10 、正确性与容错性要求 10 、可重用性要求 11 、interface 使用注意事项 11 、类使用注意事项 11 、流程控制语句注意事项 12 3.2.8 、其他应注意事项 13 注：Pascal 命名法则：即名称中所有单词的第一个字母大写其他字母使用小写形式。 Camel 命名法则：即名称中第一个单词各个字母全部小写，其他部分遵循 Pascal 命名法则。 1、第一章 命名规 、第一节 总则 本命名规则除特殊提及外统一使用 Camel 命名法则。如：controlMenu 命名时尽量不使用拼音，更不可使用拼音缩写（专有名词除外）。 如果使用品牌名称命名时其大小写尽量保持和品牌名称一致的样式。 如：LuX 则命名时，不要写成LUX，或者Lux，而应该保持与原品牌名称风格一致使用 LuX 使用专有名词或英文缩写命名时采用大写形式。如：CNNIC 禁止使用仅区分大小写的方式命名。 如：Abc 与 abc 仅用大写 A 来区分，这样写在类 C 系语言中不会出错，但是不利于系统的迁移 、第二节 变量命名规 、CodeBehind 部命名规 公有字段/属性使用 Pascal 命名规则，私有变量/保护变量/局部变量使用 Camel 命名规则，遵循动宾结构。 例： public class Hello { private string userName; private DateTime loginTime; private bool isOnline; public string UserName { get { return this.userName; } } } 即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用意义描述性的名称。仅对于短循环索引使用单字母变量名，如 i 或 j 在变量名中使用互补对，如 Min/Max、Begin/End 和 Open/Close。4．当一个方法部变量繁多的时候，可以使用Camel 命名法则，其中第一个单词可以使 用变量类型的缩写来说明以示区别。例： string strName; int intAge; object objPerson; 、控件命名规 控件缩写声明 控件 缩写 声明 Label lbl protected Label lblName; TextBox txt protected TextBox txtContent; CheckBox chk protected CheckBox chkRight; Button btn protected Button btnOK; ListBox lbx protected ListBox lstItem; DropDownList ddl protected DropDownList ddlArea; etc. 、第三节 常量命名规 常量名也应当有一定的意义，格式为 NOUN 或 NOUN_VERB。常量名均为大写，字之间用下划线分隔。 例： private const bool WEB_ENABLEPAGECACHE_DEFAULT = true; private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT = 3600; private const bool WEB_ENABLESSL_DEFAULT = false; 注： 变量名和常量名最多可以包含 255 个字符，但是，超过 25 到 30 个字符的名称比较笨拙。此外，要想取一个