CSharp编码命名规则.doc

C#编码命名规则1. 基本规则第一个字母必须大写，并且后面的并发连结词的第一个字母均为大写例：GeneralManager、SmallDictionary、StringUtil2. 接口命名规则接口名称前加“I”interface ICompareint compare();类的命名类名添加cls前缀public class clsTextBoxpublic void DataBind() WebServer的命名类名添加ws前缀public class wsTextBoxpublic void DataBind() 方法、属性的命名使用Pascal大小写形式，一般将其命名为动宾短语.ShowDialog()CreateFile()变量、参数使用Camel 大小写形式例：int totalCount常量全部大写，单词之间以 “_” 分隔例：USER_PASSWORD 代码的缩进用Tab，而不要用space其他代码命名规则1. 局部变量的名称要有意义.不要用x，y，z等等（循环变量除外）2. 所有的成员变量声明在类的顶端，用一个换行把它和方法分开3. 文件名要能反应类的内容，最好是和类同名，一个文件中一个类.4. 大括号要新起一行.public class AuthorAttribute : Attribute5. switch语句一定要有default来处理意外情况6. 同程序外部连接（数据库、接口、文件等）一定要捕获任何类型的异常（try）给出友好的消息给用户，必要时用日志记录错误的细节，包括发生的时间，和相关方法，类名等。不要“捕捉了异常却什么也不做”7. 始终使用 包含if/else下的语句，即使只有一条语句8. 把引用的系统的namespace和自定义或第三方的分开9. 自定义的属性以Attribute结尾public class AuthorAttribute : Attribute10. 自定义的异常以Exception结尾public class AppException : Exception11. 注释需和代码对齐12. 用一个空行来分开代码的逻辑分组13. 花括弧 ( ) 需和括号外的代码对齐14. 不在代码中使用具体的路径和驱动器名，使用相对路径，并使路径可编程数据库命名规则15. 表：e业务表中相对独立的实体表（例如：课程资源表）r业务中产生的关联表（例如：选课表）b系统中的基本表（例如：类型表、民族、地区）16. 视图：v_ 首字母大写17. 存储过程：sp_ 首字母大写18. 触发器：t _ 首字母大写19. 函数过程：fn_ 首字母大写20. 列名：一般第一列名为ID、主键、标识递增其他列名尽可能用英文单词或英文缩写，如英文过长（超过6位）或过于生僻可用汉语拼音的首字母。控件命名:Control type prefix ExampleButtonbtnbtnOKGrid grd grdPrices 3D Panel pnl pnlGroup ADO Data ado adoBiblio Animated button ani aniMailBox Check 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 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 注记Pascal 大小写形式所有单词第一个字母大写，其他字母小写。Camel 大小写形式除了第一个单词，所有单词第一个字母大写，其他字母小写。C#编码规则举例C#编码规则规则约定例子（说明）用pascal规则来命名方法和类型 public class MyClass public void DataBind();用camel规则来命名局部变量和方法的参数public void AddUser(string userId) string userName;所有的类成员变量前加前缀“_”对外公开名称用pascal规则命名 private class MyClass private string _userName; public string UserName get set 接口的名称加前缀“I”Interface ICompare枚举的命名是Pascal命名public enum ProductType常量命名全部大写，单词间以下划线间隔public const int LOCK_SECONDS = 3000;自定义的属性以Attribute结尾 public class AuthorAttribute:Attribute自定义的异常以Exception结尾public class MyException:Exception方法的命名一般将其命名为动宾短语ShowDialog()用有意义的名字命名namespace，如：产品名、公司名。函数、属性、类等注释请使用“/”三斜线注释这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。以protected，protected Internal，public声明的定义注释请都以这样命名方法。文件头部注释标注出创始人、创始时间、修改人、修改时间、代码的功能这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的手。 使用空格 1: 双目操作符的前后加空格 2: 单目操作符前加空格 3: 逗号、分号只在后面加空格使用空行在一段功能代码、或者函数、属性之间插入空行，这样会很直观。类的成员数据/方法调用时，应该加上this限定符 this在编辑环境中是蓝色的，更利于我们区分局部变量、参数或静态变量，并且利于FXCop检测区分。命名缩写不要使用缩写命名 我们从来不害怕长的变量命名，而却担心看不懂的命名。好的命名不需要注释。文字常量和数字常量不要硬编码，应该用常量类或枚举代替。尽量少使用三