[c开发规范.docVIP

有限公司 C# 开 发 规 范 二○○ 年 月 日 文档信息： 文档名称 C# 代码规范 描述 该文档描述了在项目开发过程中，开发人员编写代码所应遵循的规范，包括命名规则，代码结构等 负责人 连惠杰 状态 征求意见版 文档变更历史： 时间 修改人 章节 描述 文档路径： 审核结果： 审核人 意见 签名档 目录 1 编程风格 - 4 - 1.1 统一编程风格的意义 - 4 - 1.2 变量命名规则 - 4 - 1.3 函数命名规则 - 5 - 1.4 类命名规则 - 5 - 1.5 常见语句书写规则 - 6 - 1.6 注释风格 - 7 - 2 代码组织 - 7 - 3 代码优化 - 8 - 3.1 代码优化的意义 - 8 - 3.2 函数内的代码优化 - 8 - 3.3 类内的代码优化 - 9 - 3.4 类之间的代码优化 - 10 - 4 调试技巧 - 10 - 4.1 编译时的错误 - 10 - 4.2 运行时的错误 - 10 - 4.3 C#常见问题 - 11 - 编程风格 统一编程风格的意义 增加开发过程代码的强壮性、可读性、易维护性 减少有经验和无经验开发人员编程所需的脑力工作 为软件的良好维护性打下好的基础 在项目范围内统一代码风格 通过人为以及自动的方式对最终软件应用质量标准 使新的开发人员快速适应项目氛围 支持项目资源的复用：允许开发人员从一个项目区域（或子项目团队）移动到另一个，而不需要重新适应新的子项目团队的氛围 一个优秀而且职业化的开发团队所必需的素质 变量命名规则 前缀（小写字母加下划线）表明变量的作用域，无前缀则表明是局部变量或函数的参数。如： m_xx 表示是类的成员变量，控件变量例外 g_xx 表示是全局变量，在C#中，也可以理解为在整个项目中都可能用到的静态变量 c_xx 或者XX表示是一个常量 名字可以有两个或三个单词组成，但通常不应多于三个。 文件名要和类名匹配，例如，对于类HelloWorld，相应的文件名应为HelloWorld.cs 针对异常捕获过程中的Exception变量命名，在没有冲突的情况下，统一命名为exp； 如果有冲突的情况下，可以用“exp”+ 标志名称，如：expSql。 如果捕获异常不需要作任何处理，则不需要定义Exception实例。 用数据类型全称中的关键字母代表特定的数据类型（一个或多个小写字母）。 常用数据类型缩写 数据类型 i int b bool str string c char f float d double ob object lbl Label txt TextBox btn Button cmb ComboBox mnu Mainmenu mnuItem MenuItem chk CheckBox grd DataGrid tm Timer frm Form pnl Panel gup GroupBox tv TreeView rdo RadioButton lb ListBox tlb ToolBar dt DateTime cn Connection cmd Command ds DataSet da DataAdapter dv DataView dbTable DataTable dbReader DataReader param Parameter dbRow DataRow dbCol DataColumn 注：如果模块中只有一个类实例对象，则可以只用简写。如Connection对象可以用cn来命名。 C#常量命名 常量名也应当有一定的意义，格式为 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 个字符的名称比较笨拙。此外，要想取一个有实际意义的名称，清楚地表达变量或常量的用途，25 或 30 个字符应当足够了。 函数命名规则 函数名用首字母大写的英文单词组合表示（如用动词+名词的方法），其中至少有