NET程序员代码规范(不含SQL规范).doc

编辑者：Mike xia夏军 编辑时间：2010-7-14成都威睿科技有限公司.NET程序员代码规范目的（1） 为了统一公司软件开发设计过程的编码规范。（2） 使网站开发人员能很方便地理解每个目录、变量、控件、类、方法的意义。（3） 保证编写出的程序都符合相同的规范，保证一致性、统一性。（4） 编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作。代码规范（1） 局部变量的名称要有意义，尽量用对应的英文命名，比如“用户姓名”变量，不要用aa，bb，cc等来命名，而要使用userName。（2） 不要使用单个字母的变量，如：i、n、x等，而要使用index、temp等。用于循环迭代的变量例外。（3） 应该使用Pascal命名法命名方法名、属性名、类名、和命名空间，且方法的命名一般将其命名为动宾短语，如：ShowDialog(); CreateFile(); (通俗来讲：就是每个单词的首字母大写)（4） 用Camel命名法命名局部变量和方法的参数。以上几条综合举例如下：public class Personprivate string firstName; /使用Camel方式命名public string FirstName() /使用Pascal方式命名getsetpublic void DoSomething()/使用动宾短语作为方法名public void Buy(string productName)（5） 仅使用匈牙利命名法对WinForms和Web控件命名，禁止使用textbox1、gridview1等默认命名，统一的控件前缀见最后附录。（6） 接口名称以大写I 作为前缀，如：ISortable，以便直观地区分接口和类。（7） 使用名字空间的层次性结构来组织各种类和接口。正确：using MyOffice.DAL（注意：引入命名空间这里要留一行）namespace MyOffice.BLL错误：using MyOfficeDALnamespace MyOfficeBLL（8） 所有代码必须保证有足够的注释，注释量要求在15%以上。需要注释的内容包括以下几种： 关键性语句（如关键的变量声明，条件判断等）。 类名前的文档注释（以/开头的注释） 包括类的简单功能说明、使用方法等。 具有复杂参数列表的方法。 一个代码块最好用#region,#endregion 来折叠 自己写的类要写清楚注释：示例：/ / 功能：/ 作者： / 时间： / 地点： / 版本：version 1.0.0 / 备注： / 修改时间：/ 修改人： / (注：以此类推，尽量把注释写全)（9） 代码缩进用Tab键，不要用空格键（10） 控件使用原则：尽可能使用Html控件，需要提交而又不用在客户端使用Javasrcipt的可以使用Web控件指导性规范（1） Web窗体建议以div+table方式布局（2） 代码中DataSet、DataTable、DataView等对象，定义时建议将ds、dt、dv作为前缀。（3） 在一个自定义的类中，建议将类中各成员有规律地组织起来。从上至下的顺序：常量、变量、属性、公有方法、私有方法。可以将每个部分用region划分开。（4） if/for/foreach/switch 语句的嵌套不宜太多，建议不超过3层。（5） 避免写太长的方法。一个典型的方法代码应该控制在100行以内（包括注释、空行、括号占用的独立一行等）。一个方法的代码如果超过100行，应该考虑将其分解为不同的方法。（6） 一个方法只完成一个任务。不要把多个任务组合到一个方法中，即使那些任务非常小。（7） 在网页布局的时候，最好把CSS样式和Javascript代码分开写成文件：CSS样式文件放到css文件夹中，Javascript文件放到js文件夹中控件命名规范控件名称简写（前缀）LabellblTextBoxtxtButtonbtnLinkButtonlnkbtnImageButtonimgbtnListBoxlstDropDownListddlDataGridddDataListdltCheckBoxchkCheckBoxListchklstRadioButtonrdoRadioButtonListrdolstImageimgPanelpnlCalendercalAdRotatorarTabletblRequiredFieldValidatorrfvCompareValidatorcpvRangeValidatorrgvRegularExpressionValidatorrevValidatorSummaryvsCrystalReportViewerrptvewComboBoxcboDataGridViewdgvDataGridView 的ColumncolGroupBoxgrpImageListiltListViewlvwListView 的 ColumnHeaderchMenuStripmspToolStripMenuItemtsmiPictureBoxpicStatusStripsspStatusLabelslblTabControltabTabPagetpTimertmrToolStriptspToolStripLabeltslblToolStripButtontsbtnToolStripDropDownButtontsddbDomainUpDowndu