c#项目撰写规范

《c#项目撰写规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、第一章概述规范制定原则1方便代码的交流和维护。2不影响编码的效率，不与大众习惯冲突。3使代码更美观、阅读更方便。4使代码的逻辑更清晰、更易于理解。术语定义Pascal大小写将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColorCamel大小写标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor第二章代码外观2.1列宽代码列宽控制在110字符左右。2.2换行当表达式超出或即将超出规定的列宽，遵循以下规则进行换行1、

2、在逗号后换行。2、在操作符前换行。2.3缩进缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。2.4空行空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。在以下情况下使用两个空行1、接口和类的定义之间。2、枚举和类的定义之间。3、类与类的定义之间。在以下情况下使用一个空行1、方法与方法、属性与属性之间。2、方法中变量声明与语句之间。3、方法与方法之间。4、方法中不同的逻辑块之间。　5、方法中的返回语句与其他的语句之间。6、属性与方法、属性与字段、方法与字段之间。2.5花括号-{}1、左花括

3、号“{”放于关键字或方法名的下一行并与之对齐。如if(condition){}publicintAdd(intx,inty){}2、左花括号“{”要与相应的右花括号“}”对齐。3、通常情况下左花括号“{”单独成行，不与任何语句并列一行。4、if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。如if(somevalue==1){somevalue=2;}5、右花括号“}”后建议加一个注释以便于方便的找到与之相应的{。如while(1){if(valid){}//ifvalidelse{}//n

4、otvalid}//endforever第三章程序注释3.1注释概述1、修改代码时，总是使代码周围的注释保持最新。2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的。4、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。5、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。6、在部署发布之前，移除所有临时或无关的

5、注释，以避免在日后的维护工作中产生混乱。7、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。8、在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。9、使用注释来解释代码的意图。它们不应作为代码的联机翻译。10、注释代码中不十分明显的任何内容。3.2文档型注释采用.Net已定义好的X

6、ml标签来标记，在声明接口、类、方法、属性、字段都应该使用XML注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。第四章　申明4.1每行声明数一行只建议作一个声明，并按字母顺序排列。如intlevel;//推荐intsize;//推荐intx,y;//不推荐4.2初始化建议在变量声明时就对其做初始化。4.3位置变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。4.4字段的声明不要使用是public或protected的实例字段。第五章命名规范5.1命名概述名称应该说明“什么”而不是

7、“如何”。例如，可以使用GetNextStudent()，而不是GetNextArrayElement()。以下几点是推荐的命名方法。1、避免容易被主观解释的难懂的名称，如方面名AnalyzeThis()，或者属性名xxK8。这样的名称会导致多义性。2、在类属性的名称中包含类名是多余的，如Book.BookTitle。而是应该使用Book.Title。3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。4、在变量名中使用互补对，如min/max、begin/end和open

8、/close。5、布尔变量名应该包含Is，这意味着Yes/No或True/False值，如fileIsFound。6、在命名状态变量时，避免使用诸如Flag的术语。状态变量不同于布尔变量的地方是它可以具有两个以上的可能值。不是使用documentFlag，而是使用更具描述性的名称，如documentFormatType。7、即使对于可能仅出现在几个代码行中的