C#代码编写全规范1[1]0

《C#代码编写全规范1[1]0》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、XXXX班C#代码规范Guilee2008年1月20文档信息：文档编号.NET代码编写规范文档名称C#代码规范文档描述该文档详细定义了计量系统开发中的C#代码编写规范，本文档是后续分模块程序编码的规范性文档。VSS中文档存放路径设计文档负责人Guilee状态定稿文档变更记录：时间修改人章节描述2008-1-20Guilee所有创建新文档相关文档：文档路径系统/开发设计文档系统/开发设计文档文档确认与评审记录：审核人审核时间意见备注项目经理2008-1-20passconfirm目录1编程风格41.1统一编程风格的意义41.2变量命名规则41.3函数命名规则51.4类命名规则

2、51.5常见语句书写规则61.6注释风格72代码组织71编程风格1.1统一编程风格的意义·增加开发过程代码的强壮性、可读性、易维护性·减少有经验和无经验开发人员编程所需的脑力工作·为软件的良好维护性打下好的基础·在项目范围内统一代码风格·通过人为以及自动的方式对最终软件应用质量标准·使新的开发人员快速适应项目氛围·支持项目资源的复用：允许开发人员从一个项目区域（或子项目团队）移动到另一个，而不需要重新适应新的子项目团队的氛围·一个优秀而且职业化的开发团队所必需的素质1.2变量命名规则·前缀（小写字母加下划线）表明变量的作用域，无前缀则表明是局部变量或函数的参数。如：§m_x

3、x表示是类的成员变量，控件变量例外§g_xx表示是全局变量§s_xx表示静态变量§c_xx或者XX(大写字母)表示是一个常量，如：PI·用数据类型全称中的关键字母代表特定的数据类型（一个或多个小写字母），如下表。(匈牙利命名法则)常用数据类型缩写数据类型iintbboolstrstringccharffloatddoubleobobjectlblLabeltxtTextBoxbtnButtoncmbComboBoxmnuMainmenumnuItemMenuItemchkCheckBoxdbgDataGridtxtTextBoxlblLabeltmTimerfrmFormp

4、nlPanelgpGroupBoxtvTreeViewrdoRadioButtonlbListBoxtlbToolBardtDateTimeconnConnectioncmdCommanddsDataSetdaDataAdapterdvDataViewdtDataTabledrDataReaderparamParameterdbrowDataRowdbcolDataColumn注：如果模块中只有一个类实例对象，则可以只用简写。如Connection对象可以用cn来命名。1.1函数命名规则·函数名用首字母大写的英文单词组合表示（如用动词+名词的方法），其中至少有一个动词·应该

5、避免的命名方式§和继承来的函数名一样。即使函数的参数不一样，也尽量不要这么做，除非想要重载它§只由一个动词组成，如：Save、Update。改成如：SaveValue、UpdateDataSet则比较好·函数参数的命名规则§函数参数应该具有自我描述性，应该能够做到见其名而知其意§用匈牙利命名法命名1.1类命名规则·类的命名通常以父类的简写开头。如：FrmXXX可看出该类从Form中继承而来·类名中尽量不要出现下划线·类变量的命名可以参照，如：FrmXXXfrmXXX=newFrmXXX()，即首字母小写即可1.2常见语句书写规则如下表所示。语句提倡的风格ifif(condi

6、tion){statements;}else{statements;}forfor(initialization;condition;update){statements;}foreachforeach(somethingincollection){statements;}switchswitch(…){case..:break;case…:break;default:}whilewhile(..){statements;}do-whiledo{statements;}while(condition);try-catchtry{statements;}catch(Excep

7、tione){handleexception;}同一代码块内的不同逻辑块之间应空一行{dostatement1;dostatement2;}函数与函数之间至少空一行，但不超三行尽量去使用foreach替代for循环因为foreach的使用效率比for循环高1.1注释风格·注释应该正确、简洁、有重点·应该写优雅的、可读性良好的代码，而不是为玄妙、晦涩的代码写注释·原则上应尽量减少程序体内代码的注释，应该保持代码本身的直接可读性·函数的注释，可以只对public或者重要的private函数进行注解2调试技巧2.1编译时