项目经理管理必备之开发规范-命名规范精选.doc

命名规范 命名总体要求 所有的命名名称都必须使用能直接体现具体含义的名字。 不能使用X，Y，Z，等无意义的名称进行定义，除循环变量除外。 不在代码中使用具体的路径和驱动器名，必须使用相对路径。 文件名 文件名使用Pascal规则，与类名相同。类文件名的名称必须要能反应类的内容，最好是和类同名，一个文件只写一个类，文件和文件夹的名称也应该精确地说明它们的用途。 如： 文件名：Login.cs 类名：public class Login 自定义控件命名 自定义控件注册时，必须以“Custom“申明。 例如： %@ Register TagPrefix=Custom Namespace=CustomComponents % 使用时： Custom:CreditCardForm runat=server ID=customCreditCard” / 类名 分类 组成 例 普通类 名词（Pascal） class UserList 抽象类 Abstract + 名词（Pascal） class AbstractUtility 派生类 修饰语 + 基类名（Pascal） class knowledgerUserList : UserList 异常类 名词 + Exception（Pascal） class AuthenticationException Form类 功能名 + Form（Pascal） Class XxForm 接口名 接口名使用Pascal规则，由名词或名词短语或描述行为的形容词组成，接口名总是以“I”为前缀。 例如：interface IUser 方法名 方法名使用Pascal规则，由【动词】+【名词】组成。 例如：GetUserName 变量、常量相关命名 分类 组成 例 普通变量 名词（Camel） string username; 常量 全大写 public const int MAXVALUE; 循环变量 名词（Camel）i，j，k int i;for (i=0;i5;++i){ 所有的成员变量必须在所有成员方法前面声明，用一个换行把它和方法分开如: public class ClsLogin { TextBox txtUserName;// TextBox txtPassWord;// public Login() { } } 参数名 参数名使用Camel规则，由【名词】组成。 例如：string loginName 属性名 属性名使用Pascal规则，由名词组成。当为bool值时应为IsXxx或CanXxx的形式。 例如：string Name，color BodyColor，bool IsPrintable 命名空间（类库） 命名空间使用Pascal规则，用“.”符号分割，其组成如下： 【公司名称】+【系统名称】+【功能或设计】 例如：namespace Xxx.Dpac.SQLserver //东方之星教师信息系统的数据访问层。 控件的命名 画面控件名使用Pascal规则，由【类型ID】+【DB字段名】组成。 例如：BtnSearch 控件类型 类型ID TextBox Txt RadioButton Rbn CheckBox Cb TabPage Tp GroupBox Gb ComboBox Cmb HscrollBar Hsb VscrollBar Vsb NumericUpDown Nud DomainUpDown Dud ListBox Lb CheckedListBox Lst LinkLabel Llbl Label Lbl DataGrid Dg Button Btn TreeView Tre Listview Lv PictureBox Pic Panel Pnl MonthCalendar Mcal DateTimePicker Dtp ADO相关控件命名规范 –建议 类型 前缀 示例 Connection con ConNorthwind Command cmd cmdReturnProducts Parameter parm parmProductID DataAdapter dad dadProducts DataReader dtr dtrProducts DataSet dst dstNorthWind DataTable dtbl dtblProduct DataRow drow drowRow98 DataColumn dcol dcolProductID DataRelation drel drelMasterDetail DataV