Capb编码规范.docx

编号：时间：2021年x月x日书山有路勤为径，学海无涯苦作舟页码：C#编码规范1概述1.1规范制定原则1方便代码的交流和维护。2不影响编码的效率，不与大众习惯冲突。3使代码更美观、阅读更方便。4使代码的逻辑更清晰、更易于理解。1.2术语定义1.2.1Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写，文件命名也采用Pascal大小写。例如：BackColor.cs1.2.2Camel大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor2注释生成XML文档2.1注释概述1修改代码时，总是使代码周围的注释保持最新。2在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍。3避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。4避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。5避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。6在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。7如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。8在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。9在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。10避免多余的或不适当的注释，如幽默的不主要的备注。11使用注释来解释代码的意图。它们不应作为代码的联机翻译。12注释代码中不十分明显的任何内容。13为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。14对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。15在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。16用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。17在所有的代码修改处加上修改标识的注释。18为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。如namespaceCaiao.Procument.Web{}//namespaceCaiao.Procument.Web2.2文档型注释该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。如///<summary>///GetContextMenu产生上下文菜单函数，并指定绑定的控件///</summary>///<paramname="simpleContextMenuList">需要显示的右键菜单名称(逗号分隔)字串</param>///<paramname="userControl">右键菜单绑定的父控件名称</param>///<returns>上下文菜单ContextMenu</returns>///<example></example>///<remarks></remarks>publicvirtualContextMenuGetContextMenu(stringsimpleContextMenuList,objectuserControl){}///<summary>MyMethodisamethodintheMyClassclass.///<para>Here'showyoucouldmakeasecondparagraphinadescription.///<seecref="System.Con