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 strin?g c char f float? d doubl?e ob objec?t lbl Label? txt TextB?ox btn Butto?n cmb Combo?Box mnu Mainm?enu mnuIt?em MenuI?tem chk Check?Box grd DataG?rid tm Timer? frm Form pnl Panel? gup Group?Box tv TreeV?iew rdo Radio?Butto?n lb ListB?ox tlb ToolB?ar dt DateT?ime cn Conne?ction? cmd Comma?nd ds DataS?et da DataA?dapte?r dv DataV?iew dbTab?le DataT?able dbRea?der DataR?eader? param? Param?eter dbRow? DataR?ow dbCol? DataC?olumn? 注：如果模块中?只有一个类?实例对象，则可以只用?简写。如Conn?ectio?n对象可以? 函数命名规?则 函数名用首?字母大写的?英文单词组?合表示（如用动词+名词的方法?），其中至少有?一个动词 应该避免的?命名方式 和继承来的?函数名一样?。即使函数的?参数不一样?，也尽量不要?这么做，除非想要重?载它 只由一个动?词组成，如：Save、Updat?e。改成如：SaveV?alue、Updat?eData?Set则比? 函数参数的?命名规则 函数参数应?该具有自我?描述性，应该能够做?到见其名而?知其意 用匈牙利命?名法命名 类命名规则? 类的命名通?常以父类的?简写开头。如：FrmXX?X可看出该?类从For?m中继承而?来 类名中尽量?不要出现下?划线 类变量的命?名可以参照?，如：FrmXX?X frmXX?X = new FrmXX?X()，即首字母小?写即可 常见语句书?写