企业绩效管理系统 (仅供参考).docVIP

绩 效 考 核 系 统 (Net One) C# 代码规范 文档信息： 文档名称 C# 代码规范 描述 该文档描述了在项目开发过程中，开发人员编写代码所应遵循的规范，包括命名规则、代码结构等 负责人 状态 文档变更历史： 时间 修改人 章节 描述 2009-1-4 所有章节 创建文档初稿 文档路径： $/NetOne/ Assess Performance/ 审核结果： 审核人 意见 签名档  目录 1 编程风格 4 1.1 统一编程风格的意义 4 1.2 变量命名规则及控件命名规范 4 1.3 函数命名规则 5 1.4 类命名规则 6 1.5 各层的类名规范 6 1.6 Form页面命名规范 6 1.7 常见语句书写规则 8 1.8 注释风格 9 2 代码优化 9 2.1 代码优化的意义 9 2.2 函数内的代码优化 9 2.3 类内的代码优化 11 2.4 类之间的代码优化 11 3 调试技巧 11 3.1 编译时的错误 11 3.2 运行时的错误 12 3.3 C#常见问题 12 4 数据库编程规则 12 4.1 表名命名规则 12 4.2 字段名命名规则 12 4.3 视图命名规则 13 4.4 存储过程命名规则 13 编程风格 统一编程风格的意义 增加开发过程代码的强壮性、可读性、易维护性 减少有经验和无经验开发人员编程所需的脑力工作 为软件的良好维护性打下好的基础 在项目范围内统一代码风格 通过人为以及自动的方式对最终软件应用质量标准 使新的开发人员快速适应项目氛围 支持项目资源的复用：允许开发人员从一个项目区域（或子项目团队）移动到另一个，而不需要重新适应新的子项目团队的氛围 一个优秀而且职业化的开发团队所必需的素质 变量命名规则及控件命名规范 前缀（小写字母加下划线）表明变量的作用域，无前缀则表明是局部变量或函数的参数。如： m_xx 表示是类的成员变量，控件变量例外 g_xx 表示是全局变量，在C#中，也可以理解为在整个项目中都可能用到的静态变量 c_xx 或者XX 表示是一个常量 用数据类型全称中的关键字母代表特定的数据类型（一个或多个小写字母），如下表。 常用数据类型缩写 数据类型 i int b bool str string c char f float d double ob object lbl Label utxted ultraTextEditor ubtn ultraButton ucmb ultraCombo ucc ultraCalendarCombo ugd ultraGrid utree ultraTree utbm ultraToolbarsManager usb ultraStatusBar ugb ultraGroupBox pnl panel upb ultraPictureBox uds ultraDataSource uddbnt ultraDropDownButton ulb ultraLabel utcl ultraTabControl tlb ToolBar dt DateTime con Connection cmd Command ds DataSet da DataAdapter dv DataView dbTable DataTable dbReader DataReader param Parameter dbRow DataRow dbCol DataColumn 注： 如果模块中只有一个类实例对象，则可以只用简写。如Connection对象可以用con来命名。 控件键命名如ultraButton 为确认键 简写为ubtn+数据字典(确认：OK) ubtnOk 函数命名规则 函数名用首字母大写的英文单词组合表示（如用动词+名词的方法），其中至少有一个动词 应该避免的命名方式 和继承来的函数名一样。即使函数的参数不一样，也尽量不要这么做，除非想要重载它 只由一个动词组成，如：Save、Update。改成如：SaveValue、UpdateDataSet则比较好 函数参数的命名规则 函数参数应该具有自我描述性，应该能够做到见其名而知其意 用匈牙利命名法命名 类命名规则 类的命名通常以父类的简写开头。如：FrmXXX可看出该类从Form中继承而来 类名中尽量不要出现下划线 类变量的命名可以参照，如：FrmXXX frmXXX = new FrmXXX()，即首字母小写即可 各层的类名规范 代码组织是对整个项目的代码进行整理，使之更加有序。实现类似功能的文件应该放在同一个文件夹中或者同一个项目中。