P8.Console命名规则.docxVIP

目的：便于理解程序的逻辑流便于两个人的项目协作便于项目的统一规范，以便后期维护命名基本原则：类名：说明是什么而不是如何，运用名词或者名词短语仅可使用数字与字母，且不准数字开头，不准使用任何前缀每个单词首字母大写自定义异常类应以Exception结尾文件名要能反映类的内容，最好是和类同名方法成员：强调做什么，而不是是什么，运用动词或者动宾短语词短语准确描述该方法的功能每个单词首字母大写方法参数：首字母小写，其余各单词首字母大写使用描述性参数名称，参数名称应当具有最够的说明性禁止加p_前缀变量成员：说明是什么而不是如何，运用名词或者名词短语统一”_”前缀，如果为布尔值，则”_is”前缀首字母小写，其余每个单词首字母大写。除非”_is”前缀，则每个单词首字母均大写类中访问修饰符或功能相同的方法应该放在一起，且公共或实现接口的方法在前属性成员：说明是什么，而不是如何，运用名词或者名词短语首字母大写，如果是布尔值，则”Is”作为前缀如果返回值是枚举类型值，则以枚举类型作为属性名属性和相应字段名称要关联，属性名除大小写区别外应该与关联的成员变量的去除前缀”_”之后的部分一致接口：统一加上前缀：I其余同类名结构体：同类名枚举：同类名委托命名：强调做什么，而不是是什么，运用动词或者动词短语准确描述该方法的功能，如CallBack表示回调委托每个单词首字母大写作为事件委托时，参数必须是sender与e。其中sender为object类型，e必须是EventArgs类型或者其子类型。（此处意味着自定义事件，必须先自定义事件，其中自定义事件必须继承自EventArgs类）。事件用到的参数类，名称要带EventArgs后缀。public?class?TestEventArgs?:?EventArgs{public?readonly?char?KeyToRaiseEvent;public?TestEventArgs(char?keyToRaiseEvent){KeyToRaiseEvent = keyToRaiseEvent;}}自定义事件的示例作为事件委托时，必须加上EventHandle作为后缀public?delegate?void?TestEventHandler(object?sender,?TestEventArgs?e);事件委托声明的示例事件命名：将事件委托的后缀Handle去掉即可。其余保持与事件委托的名称一致public?event?TestEventHandler?TestEvent;事件命名示例命名长度不宜超过三个单词变量名不可以泛写，如不准出现Flag之类的命名，命名必须准确描述是什么，如DocType变量名命名需利用面向对象思想减少冗余常量命名规范??UPPER，如const MAXTIME;临时变量可加tmp前缀以示区别代码书写格式规范文件之中不得存在无规则的空行，比如说连续十个空行。函数与函数之间的空行为2行。函数与函数之间统一空格两行。#region以及#endregion与相邻代码块之间空格一行。属性声明之间空1行，成员变量声明之间无需空行。#region代码块之间空格两行在函数体内部，在逻辑上独立的两个函数块可适当空行，一般为1行。每行长度尽量避免超过屏幕宽度，应不超过80个字符。（自动换行）使用括号清晰地表达算术表达式和逻辑表达式的运算顺序。如将?x=a*b/c*d 写成 x=(a*b/c)*d可避免阅读者误解为x=(a*b)/(c*d)。避免过多的循环嵌套和条件嵌套。一个函数不要超过200行。一个文件应避免超过2000行。正常方法控制在40行内，类控制在400行内。禁止采用多赋值语句，如x = y = z;。代码注释规范.cs文件的注释　　?所有.cs文件开头都要加上注释，写明文件创建时间、作者、用途概述等//********************************************************//新增日期:2004.7.19//作者:XXX//內容说明:　XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX//********************************************************.cs文件头注释示例函数过程注释所有的函数体开头都要加上注释，所以注释使用.NET注释规范///summary/// 用途描述////summary///param name=xxx1参数：STRING 描述/param///param name=xxx2参数：STRING 描述/param///returns返回：INT 描述/returnspublicint UpgradeThread(stringxxx1, stringxxx2) {