C#编程规范标准---上.pdf

《C#编程规范标准---上.pdf》由会员分享，可在线阅读，更多相关《C#编程规范标准---上.pdf（16页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、C#编程规范标准-上 疯狂代码 http:/CrazyC 1 概述 1.1规范标准制定原则 1)方便代码交流和维护 2)不影响编码效率不和大众习惯冲突 3)使代码更美观、阅读更方便 4)使代码逻辑更清晰、更易于理解 1.2术语定义 1)Pascal 大小写 将标识符首字母和后面连接每个单词首字母都大写可以对 3或更多标识符使用Pascal 大小写例 BackColor 2)Camel 大小写 标识符首字母小写而每个后面连接单词首字母都大写例如:backColor 1.3文件命名组织 1.3.1 文件命名1)文件名遵从Pascal命名法无特殊情况扩展名小写 2)使用统而又通用文件扩展名:C#类.

2、cs 1.3.2 文件注释1)在每个文件头必须包含以下注释介绍说明 /*-/Copyright(C)公司名称 /版权所有 /文件名:/文件功能描述:/创建标识:/修改标识:/修改描述:/修改标识:/修改描述:/-*/2)文件功能描述只需简述具体详情在类注释中描述 3)创建标识和修改标识由创建或修改人员拼音或英文名加日期组成如:姚明20040408 4)天内有多个修改只需做个在注释介绍说明中做个修改标识就够了 5)在所有代码修改处加上修改标识注释 2 代码外观 2.1列宽 代码列宽控制在110左右原则上不超过屏宽 2.2换行 当表达式超出或即将超出规定列宽遵循以下规则进行换行:1、在逗号括号后换

3、行 2、在操作符前换行 3、规则1优先于规则2 当以上规则会导致代码混乱时候自己采取更灵活换行规则 2.3缩进 缩进应该是每行个Tab(4个空格)不要在代码中使用Tab Visual Studio.Net设置:工具-选项-文本编辑器-C#-制表符-插入空格 2.4空行 空行是为了将逻辑上相关联代码分块以便提高代码可阅读性 在以下情况下使用两个空行:1、接口和类定义的间 2、枚举和类定义的间 3、类和类定义的间 在以下情况下使用个空行:1、思路方法和思路方法、属性和属性的间 2、思路方法中变量声明和语句的间 3、思路方法和思路方法的间 4、思路方法中区别逻辑块的间 5、思路方法中返回语句和其他语

4、句的间 6、属性和思路方法、属性和字段、思路方法和字段的间 7、注释和它注释语句间不空行但和其他语句间空行 8、文件的中不得存在无规则空行比如说连续十个空行空行是为了将逻辑上相关联代码分块以便提高代码可阅读性 2.5空格 在以下情况中要使用到空格:1、关键字和左括符“(”应该用空格隔开如 while(true)注意在思路方法名和左括符“(”的间不要使用空格这样有助于辨认代码中思路方法和关键字 2、多个参数用逗号隔开每个逗号后都应加个空格 3、除了.的外所有 2元操作符都应用空格和它们操作数隔开元操作符、及-和操作数间不需要空格如 ac+d;a=(a+b)/(c*d);while(d=s)n;P

5、rSize(“size is“+size+“n”);4、语句中表达式的间用空格隔开如 for(expr1;expr2;expr3)2.6花括号-1、左花括号“”放于关键字或思路方法名下行并和的对齐如 (condition)public Add(x,y)2、左花括号“”要和相应右花括号“”对齐 3、通常情况下左花括号“”单独成行不和任何语句并列行 4、while、do语句后定要使用即使号中为空或只有条语句如 (somevalue 1)somevalue=2;5、右花括号“”后建议加个注释以便于方便找到和的相应 如 while(1)(valid)/valid /not valid /end for

6、ever 3 注释 3.1注释概述 1)修改代码时总是使代码周围注释保持最新 2)在每个例程开始提供标准注释样本以指举例程用途、假设和限制很有帮助注释样本应该是解释它为什么存在和可以做什么简短介绍.3)避免在代码行末尾添加注释；行尾注释使代码更难阅读不过在批注变量声明时行尾注释是合适；在这种情况下将所有行尾注释在公共制表位处对齐 4)避免杂乱注释如整行星号而是应该使用空白将注释同代码分开 5)在部署发布的前移除所有临时或无关注释以避免在日后维护工作中产生混乱 6)如果需要用注释来解释复杂代码节请检查此代码以确定是否应该重写它尽切可能不注释难以理解代码而应该重写它尽管般不应该为了使代码更简单以便

7、于人们使用而牺牲性能但必须保持性能和可维护性的间平衡 7)在编写注释时使用完整句子注释应该阐明代码而不应该增加多义性 8)在编写代码时就注释以后很可能没有时间这样做另外如果有机会复查已编写代码在今天看来很明显东西 6周以后或许就不明显了 9)避免多余或不适当注释如幽默不主要备注 10)使用注释来解释代码意图它们不应作为代码联机翻译 11)注释代码中不十分明显任何内容 12)为了防止问题反复出现对修复和解决思路方法代码总是使用注释 13)对由循环和逻辑分支组成代码使用注释这些是帮助源代码读者主要方面 14)在整个应用中使用具有致标点和结构统样式来构造注释 15)在所有代码修改处加上修改标示注释

8、16)为了是层次清晰在闭合右花括号后注释该闭合所对应起点 Langchao.Procument.Web /Langchao.Procument.Web 3.2文档型注释 该类注释采用.Net已定义好Xml标签来标记在声明接口、类、思路方法、属性、字段都应该使用该类注释以便代码完成后直接生成代码文档让别人更好了解代码实现和接口如 /MyMethod is a method in the MyClass./Heres how you could make a second paragraph in a description./for information about output statem

9、ents./public void MyMethod(Int1)3.3类c注释 该类注释用于 1)不再使用代码 2)临时测试屏蔽某些代码 使用方法 /*修改标识 修改原因.(the source code)*/3.4单行注释 该类注释用于 1)思路方法内代码注释如变量声明、代码或代码段解释注释举例:/注释语句/private number;或 /注释语句 private number;2)思路方法内变量声明或花括号后注释,注释举例:(1 1)/always true statement;/always true 4 申明 4.1每行声明数 行只建议作个声明并按字母顺序排列如:level;/推荐

10、 size;/推荐 x,y;/不推荐 4.2化 建议在变量声明时就对其做化 4.3位置 变量建议置于块开始处不要总是在第次使用它们地方做声明如:void MyMethod 1=0;/beginning of method block (condition)2=0;/beginning of block.不过也有个例外:for(i=0;i maxLoops;i).应避免区别层次间变量重名如:count;.void MyMethod (condition)count=0;/避免 .4.4类和接口声明 1)在思路方法名和其后左括号间没有任何空格 2)左花括号“”出现在声明下行并和的对齐单独成行 3)

11、思路方法间用个空行隔开 4.5字段声明 不要使用是 public 或 protected 例子字段如果避免将字段直接公开给开发人员可以更轻松地对类进行版本控制原因是在维护 2进制兼容性时字段不能被更改为属性考虑为字段提供 get 和 属性访问器而不是使它们成为公共 get 和 属性访问器中可执行代码存在使得可以进行后续改进如在使用属性或者得到属性更改通知时根据需要创建对象下面代码举例阐释带有get 和 属性访问器私有例子字段正确使用举例:public Control:Component private handle;public Handle get handle;5 第 5章命名规范标准 5

12、.1命名概述 名称应该介绍说明“什么”而不是“如何”通过避免使用公开基础实现(它们会发生改变)名称可以保留简化复杂性抽象层例如可以使用 GetNextStudent而不是 GetNextArrayElement 命名原则是:选择正确名称时困难可能表明需要进步分析或定义项目使名称足够长以便有定意义并且足够短以避免冗长唯名称在编程上仅用于将各项区分开表现力强名称是为了帮助人们阅读；因此提供人们可以理解名称是有意义其实从长变量名负面作用 3Ctrl+C和Ctrl+V加上在VS中智能感知其负面追用已经很小最优秀代码它本身就是注释作为流员并不仅仅实现功能而是要让我们代码更加优美具备让他人维护或今后扩充能

13、力作为现在业务系统其门槛准入水平已大大降低实现功能上需求已没有什么难度但是高手和菜鸟区别在于高手代码通俗易懂在整个编码过程中不仅能考虑到性能、还会考虑代码可读性和维护性不过请确保选择名称符合适用语言规则和标准 以下几点是推荐命名思路方法 1)避免容易被主观解释难懂名称如命名 AnalyzeThis或者属性名 xxK8这样名称会导致多义性 2)在类属性名称中包含类名是多余如 Book.BookTitle而是应该使用 Book.Title 3)只要合适在变量名末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)4)在变量名中使用互补对如 min/max、begin/end 和 op

14、en/close 5)布尔变量名应该包含 Is这意味着 Yes/No 或 True/False 值如 fileIsFound 6)在命名状态变量时避免使用诸如 Flag 术语状态变量区别于布尔变量地方是它可以具有两个以上可能值不是使用 documentFlag而是使用更具描述性名称如 documentFormatType(此项只供参考)7)即使对于可能仅出现在几个代码行中生存期很短变量仍然使用有意义名称仅对于短循环索引使用单字母变量名如 i 或 j 可能情况下尽量不要使用原义数字或原义串如 For i=1 To 7而是使用命名常数如 For i=1 To NUM_DAYS_IN_WEEK 以便

15、于维护和理解 8)文件名要和类名相同般情况下个类个文件 5.2大小写规则 下表汇总了大写规则并提供了区别类型标识符举例 标识符 大小写 举例 类 Pascal AppDo 枚举类型 Pascal ErrorLevel 枚举值 Pascal FatalError 事件 Pascal ValueChange 异常类 Pascal WebException 注意 总是以 Exception 后缀结尾 只读静态字段 Pascal RedValue 接口 Pascal IDisposable 注意 总是以 I 前缀开始 思路方法 Pascal 命名空间 Pascal .Drawing 属性 Pascal

16、 BackColor 公共例子字段 Pascal RedValue 注意 很少使用属性优于使用公共例子字段 受保护例子字段 Camel redValue 注意 很少使用属性优于使用受保护例子字段 私有例子字段 Camel redValue 参数 Camel typeName 思路方法内变量 Camel backColor 5.3缩写 为了避免混淆和保证跨语言交互操作请遵循有关区缩写使用下列规则:1)不要将缩写或缩略形式用作标识符名称组成部分例如使用 GetWindow而不要使用 GetWin 2)不要使用计算机领域中未被普遍接受缩写 3)在适当时候使用众所周知缩写替换冗长词组名称例如用 UI

17、作为 User Interface 缩写用 OLAP 作为_disibledevent=y;public X get x;public Y get y;5.13常量(const)使用Pascal命名 5.14字段 以下规则概述字段命名指南:1)private、protected 使用 Camel 大小写 2)public 使用 Pascal 大小写 3)拼写出字段名称中使用所有单词仅在开发人员般都能理解时使用缩写字段名称不要使用大写字母下面是正确命名字段举例 SampleClass url;destinationUrl;4)不要对字段名使用匈牙利语表示法好名称描述语义而非类型 5)不要对字段名

18、或静态字段名应用前缀具体说来不要对字段名称应用前缀来区分静态和非静态字段例如应用 g_ 或 s_ 前缀是不正确 5.15静态字段 以下规则概述静态字段命名指南:1)使用名词、名词短语或者名词缩写命名静态字段 2)使用 Pascal 大小写 3)对静态字段名称使用匈牙利语表示法前缀 4)建议尽可能使用静态属性而不是公共静态字段 5.16集合 集合是组组合在起类似类型化对象如哈希表、查询、堆栈、字典和列表集合命名建议用复数 5.17范型 如果你对类型参数没有其他跟上下文有关信息(additionalcontextualinformation)你应该使用字母T:5.18措词 避免使用和常用.NET

19、框架命名空间重复类名称例如不要将以下任何名称用作类名称:、Collections、Forms 或 UI有关.NET 框架命名空间列表请参阅类库 另外避免使用和以下关键字冲突标识符 AddHandler AddressOf Alias And Ansi As Assembly Auto Base Boolean ByRef Byte ByVal Call Case Catch CBool CByte Cchar CDate CDec CDbl Char C Class CLng CObj Const C CSng CStr CType Date Decimal Declare Default D

20、elegate Dim Do Double Each Else ElseIf End Enum Erase Error Event Exit ExternalSource False Finalize Finally Float For Friend Function Get GetType Goto Handles If Implements Imports In Inherits Integer Interface Is Let Lib Like Long Loop Me Mod Module MustInherit MustOverride MyBase MyClass Namespac

21、e New Next Not Nothing NotInheritable NotOverridable Object On Option Optional Or Overloads Overridable Overrides ParamArray Preserve Private Property Protected Public RaiseEvent ReadOnly ReDim Region REM RemoveHandler Resume Return Select Set Shadows Shared Short Single Static Step Stop String Structure Sub SyncLock Then Throw To True Try TypeOf Unicode Until volatile When While With WithEvents WriteOnly Xor Eval extends instanceof package var 2009-1-9 13:25:30 疯狂代码 http:/CrazyC