C#代码规范〔湖南大学).docVIP

创新课程 参考案例 铁路局计量管理系统 C#代码规范 湖南大学软件学院 2007年8月 文档信息： 文档编号 MMIS-03 文档名称 计量系统C#代码规范 文档描述 该文档详细定义了计量系统开发中的C#代码编写规范，本文档是后续分模块程序编码的规范性文档。 VSS中文档存放路径 $/××学院/软件开发部/计量系统/开发设计文档 负责人 ××× 状态 定稿 文档变更记录： 时间 修改人 章节 描述 2007-05-29 陈浩 所有 创建新文档 相关文档： 文档 路径 计量系统需求分析说明书 $/××学院/软件开发部/计量系统/开发设计文档 计量系统功能说明书 $/××学院/软件开发部/计量系统/开发设计文档 文档确认与评审记录： 审核人 审核时间 意见 备注 项目组 2005-7-28 评审通过 用户评审确认 目 录 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 表示是一个常量 用数据类型全称中的关键字母代表特定的数据类型（一个或多个小写字母），如下表。 常用数据类型缩写 数据类型 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来命名。 函数命名规则 函数名用首字母大写的英文单词组合表示（如用动词+名词的方法），其中至少有一个动词 应该避免的命名方式 和继承来的函数名一样。即使函数的参数不一样，也尽量不要这么做，除非想要重载它 只由一个动词组成，如：Save、Update。改成如：SaveValue、UpdateDataSet则比较好 函数参数的命名规则 函数参数应该具有自我描述性，应该能够做到见其名而知其意 用匈牙利命名法命名 类命名规则 类的命名通常以父类的简写开头。如：FrmXXX可看出该类从Form中继承而来 类名中尽量不要出现下划线 类变量的命名可以参照，如：FrmXXX frmXXX = new FrmXXX()，即首字母小写即可 常见语句书写规则 如下表所示。 语句 提倡的风格 if if(condition) { statements; } else { statements; } for for(initialization; condition; update) { statements; } foreach foreach(somet