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

成都威睿科技有限公司.NET程序员代码规范 目的 为了统一公司软件开发设计过程的编码规范。 使网站开发人员能很方便地理解每个目录、变量、控件、类、方法的意义。 保证编写出的程序都符合相同的规范，保证一致性、统一性。 编码规范和约定必须能明显改善代码可读性，并有助于代码管理、分类范围适用于企业所有基于.NET平台的软件开发工作。 代码规范 局部变量的名称要有意义，尽量用对应的英文命名，比如“用户姓名”变量，不要用aa，bb，cc等来命名，而要使用userName。 不要使用单个字母的变量，如：i、n、x等，而要使用index、temp等。用于循环迭代的变量例外。 应该使用Pascal命名法命名方法名、属性名、类名、和命名空间，且方法的命名一般将其命名为动宾短语，如：ShowDialog(); CreateFile(); (通俗来讲：就是每个单词的首字母大写) 用Camel命名法命名局部变量和方法的参数。 以上几条综合举例如下： public class Person { private string firstName; //使用Camel方式命名 public string FirstName() //使用Pascal方式命名 { get{} set{} } public void DoSomething() //使用动宾短语作为方法名 { } public void Buy(string productName) } 仅使用匈牙利命名法对WinForms和Web控件命名，禁止使用textbox1、gridview1等默认命名，统一的控件前缀见最后附录。 接口名称以大写I 作为前缀，如：ISortable，以便直观地区分接口和类。 使用名字空间的层次性结构来组织各种类和接口。 正确： using MyOffice.DAL （注意：引入命名空间这里要留一行） namespace MyOffice.BLL { … } 错误： using MyOfficeDAL namespace MyOfficeBLL { … } 所有代码必须保证有足够的注释，注释量要求在15%以上。需要注释的内容包括以下几种： 关键性语句（如关键的变量声明，条件判断等）。 类名前的文档注释（以///开头的注释） 包括类的简单功能说明、使用方法等。 具有复杂参数列表的方法。 一个代码块最好用#region,#endregion 来折叠 自己写的类要写清楚注释： 示例： /// summary /// 功能： /// 作者： /// 时间： /// 地点： /// 版本：version 1.0.0 /// 备注： /// 修改时间： /// 修改人： /// /summary (注：以此类推，尽量把注释写全) 代码缩进用Tab键，不要用空格键 控件使用原则：尽可能使用Html控件，需要提交而又不用在客户端使用Javasrcipt的可以使用Web控dlt CheckBox chk CheckBoxList chklst RadioButton rdo RadioButtonList rdolst Image img Panel pnl Calender cal AdRotator ar Table tbl RequiredFieldValidator rfv CompareValidator cpv RangeValidator rgv RegularExpressionValidator rev ValidatorSummary vs CrystalReportViewer rptvew ComboBox cbo DataGridView dgv DataGridView 的Column col GroupBox grp ImageList ilt ListView lvw ListView 的 ColumnHeader ch MenuStrip msp ToolStripMenuItem tsmi PictureBox pic StatusStrip ssp StatusLabel slbl TabControl tab TabPage tp Timer tmr ToolStrip tsp ToolStripLabel tslbl ToolStripButton tsbtn ToolStripDropDownButton tsddb DomainUpDown dud TreeView tv tvw WebBrowser wb ObjectDataSource ods FileUpload ful Hid