工程开发如何命名.doc

1 编写目的为了使团队中的每一位成员都形成统一的开发约定，特制定本规范文档，在今后的开发过程中，请严格按照此文档约定的规则进行编码。通过此规范，希望可以给各程序员之间起到沟通的桥梁的作用，并增强程序的可读性。如在使用过程中，碰到本文档中没进行约定的规则，待商议后对该文档进行补充完善。2 程序命名规范基本约定l 所有的命名名称都必须使用能直接体现具体含义的名字。不能使用X，Y，Z，等无意义的名称进行定义，除循环变量除外。l 所有的成员变量必须在所有成员方法前面声明，用一个换行把它和方法分开如: public class ClsLoginTextBox txtUserName;/TextBox txtPassWord;/public Login()l 类文件名的名称必须要能反应类的内容，最好是和类同名，一个文件只写一个类，文件和文件夹的名称也应该精确地说明它们的用途。如：文件名：Login.cs 类名：public class ClsLoginl 大括号要新起一行。正确编写：public class ClsLogin错误编写：public class ClsLoginl switch语句一定要有default来处理意外情况。l 同程序外部连接（如连接数据库、接口、文件等）一定要捕获任何类型的异常（try）给出友好的消息给用户，必要时用日志记录错误的细节，包括发生的时间，和相关方法，类名等。l 始终使用 包含if/else下的语句，即使只有一条语句。正确编写：if (true) /语句。 错误编写：if (true) /语句。l 把引用的系统的namespace和自定义或第三方的分开。using System;using System.Web;using System.Web.Security;using System.Web.UI;using System.Web.UI.WebControls;using MYNameSpace.NameSpace;l 不同函数或方法之间，需要用空行来分开。如：public class ClsLoginpublic Login()Public Login()l 不在代码中使用具体的路径和驱动器名，必须使用相对路径。l 代码的缩进用Tab，而不要用space。l 使用某个控件的值时，尽量命名局部变量。public string GetTitle() string StrTitle=lblTitle.Text;StrTitle += StrTitle;return StrTitle; l 一个方法只完成一个任务。不要把多个任务组合到一个方法中。l 避免使用大文件。如果一个文件里的代码超过300400行，必须考虑将代码分开到不同类中。控件命名规范以下控件为常用的控件命名规范，按英文字母进行升序排列。在此列表中未定义的控件，将后期补充完善。控件类型 命名前缀 举例3D Panel pnl pnlGroup ADO Data ado adoBiblio Animated button ani aniMailBox ButtonbtnbtnOKCheck box chk chkReadOnly Combo box cbo cboEnglishDropdown list box ddlddlUserCommand button cmd cmdExit Common dialog dlg dlgFileOpen Communications com comFaxControl (used within procedures when the specific type is unknown) ctr ctrCurrent Data dat datBiblio Data-bound combo box dbcbo dbcboLanguage Data-bound grid dbgrd dbgrdQueryResult Data-bound list box dblst dblstJobType Data combo dbc dbcAuthor Data grid dgd dgdTitles Data list dbl dblPublisher Data repeater drp drpLocation Date picker dtp dtpPublished Directory list box dir dirSource Drive list box drv drvTarget File list box fil filSource Flat scroll bar fsb fsbMove Form frm frmEntry Frame fra fraLanguage Gauge gau gauStatus Graph gra graRevenue Grid grd grdPrices Hierarchical flexgrid flex flexOrders Horizontal scroll bar hsb hsbVolume Image img imgIcon Image combo imgcbo imgcboProduct ImageList ils ilsAllIcons Label lbl lblHelpMessage Lightweight check box lwchk lwchkArchive Lightweight combo box lwcbo lwcboGerman Lightweight command button lwcmd lwcmdRemove Lightweight frame lwfra lwfraSaveOptions Lightweight horizontal scroll bar lwhsb lwhsbVolume Lightweight list box lwlst lwlstCostCenters Lightweight option button lwopt lwoptIncomeLevel Lightweight text box lwtxt lwoptStreet Lightweight vertical scroll bar lwvsb lwvsbYear Line lin linVertical List box lst lstPolicyCodes ListView lvw lvwHeadings MAPI message mpm mpmSentMessage MAPI session mps mpsSession MCI mci mciVideo Menu mnu mnuFileOpen Month view mvw mvwPeriod MS Chart ch chSalesbyRegion MS Flex grid msg msgClients MS Tab mst mstFirst OLE container ole oleWorksheet Option button opt optGender Picture box pic picVGA Picture clip clp clpToolbar ProgressBar prg prgLoadFile Remote Data rd rdTitles RichTextBox rtf rtfReport Shape shp shpCircle Slider sld sldScale Spin spn spnPages StatusBar sta staDateTime SysInfo sys sysMonitor TabStrip tab tabOptions Text box txt txtLastName Timer tmr tmrAlarm Toolbar tlb tlbActions TreeView tre treOrganization UpDown upd updDirection Vertical scroll bar vsb vsbRate ADO.NET控件命名规范 类型 前缀示例ConnectionconconNorthwind CommandcmdcmdReturnProductsParameterparmparmProductIDDataAdapterdaddadProductsDataReaderdtrdtrProductsDataSetdstdstNorthWindDataTabledtbldtblProductDataRowdrowdrowRow98DataColumndcoldcolProductIDDataRelationdreldrelMasterDetailDataViewdvwdvwFilteredProducts自定义控件命名规范自定义控件注册时，必须以“Custom“申明。例如：使用时：类型声明在定义变量时，以前缀开头，再加上变量声明符，为了不与系统控件命名起冲突，类型命名时，前缀第一个字母大写。l 整型类型 前缀示例SbyteSbySbySexShort ShrShrAverageIntIntIntRowCounterLong LngLngBillGatesIncomeByteBytBytPixelValueUshortUshrUshrMoneyUintUintUintCountUlongUlngUlngCountl 浮点型类型 前缀示例FlostFotFotMoneyDoubleDouDouMoneyDecimalDecDecMoneyl Bool类型类型 前缀示例BoolBooBooIsPostBackl 字符类型类型 前缀示例CharChrChrSelectSexl 引用类型类型 前缀示例ObjectObjObjReturnValueStringStrStrName常量全部大写，单词之间以 “_” 分隔，例：USER_PASSWORD。类的命名类名必须以Cls前缀开头。例如: public class ClsTextBoxpublic void DataBind() 抽象类定义抽象类必须以AbsCls前缀开头。例如：public abstract class AbsClsTextBox密封类定义密封类必须以SeaCls前缀开头。例如：public sealed class SeaClsTextBox 方法定义大小写形式，一般将其命名为动宾短语.如：ShowDialog()CreateFile()虚方法定义在方法定义的基础上，加上Vir前缀来表示虚方法。如：public virtual string VirShowDialog () public virtual string VirCreateFile () 类的成员定义参照类型声明；结构定义结构名必须以Srt前缀开头。如: public struct SrtDimensions public string StrName; public string StrPassword; 结构成员定义参照类型声明；接口定义接口名称前加I前缀开头。interface ICompare接口的方法和成员定义参照类的方法和成员的定义规则。自定义异常定义自定义异常类型以Cls前缀开头，以Exception作为后缀命名。例：public class ClsMyException : Exception 注释规范1、 注释必须使用中文及中文的标点符号。 2、 每行注释的最大长度不能超过1024*800的宽度，且需要与代码对齐。 3、 将注释与注释分隔符用一个空格分开。 4、 编码的同时书写注释。 5、 重要变量必须有注释。 6、 变量注释和变量在同一行，所有注释必须对齐，与变量分开至少两个Tab键。 7、 典型算法必须有