C#编码规范

 

源于：亮剑.NET

第一章　概述

规范制定原则

1 方便代码的交流和维护。
2 不影响编码的效率，不与大众习惯冲突。
3 使代码更美观、阅读更方便。
4 使代码的逻辑更清晰、更易于理解。


术语定义

Pascal 大小写

将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如：BackColor

Camel 大小写

标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor


文件命名组织

1.3.1文件命名

1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。
2 使用统一而又通用的文件扩展名： C# 类  .cs


1.3.2文件注释

1 在每个文件头必须包含以下注释说明

 

/*----------------------------------------------------------------
// Copyright (C) 2008 公司名称 版权所有。
//
// 文件名：
// 文件功能描述：
//
//
// 创建标识：
//
// 修改标识：
// 修改描述：
//
// 修改标识：
// 修改描述：
//----------------------------------------------------------------*/

文件功能描述只需简述，具体详情在类的注释中描述。
创建标识和修改标识由创建或修改人员的拼音或英文名加日期组成。如：李轶20040408

一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。
在所有的代码修改处加上修改标识的注释。


第二章   代码外观

2.1   列宽

代码列宽控制在110字符左右。

2.2   换行

当表达式超出或即将超出规定的列宽，遵循以下规则进行换行

1、在逗号后换行。
2、 在操作符前换行。
3、规则1优先于规则2。

当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。


2.3   缩进

缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。
Visual Studio.Net设置：工具->选项->文本编辑器->C#->制表符->插入空格


2.4   空行

空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。

在以下情况下使用两个空行

1、接口和类的定义之间。
2、枚举和类的定义之间。
3、类与类的定义之间。        

在以下情况下使用一个空行

1、方法与方法、属性与属性之间。
2、方法中变量声明与语句之间。
3、方法与方法之间。
4、方法中不同的逻辑块之间。
5、方法中的返回语句与其他的语句之间。
6、属性与方法、属性与字段、方法与字段之间。
7、注释与它注释的语句间不空行，但与其他的语句间空一行。


2.5   空格

在以下情况中要使用到空格

1、 关键字和左括符 “(” 应该用空格隔开。如

 

while (true)

注意在方法名和左括符 “(” 之间不要使用空格，这样有助于辨认代码中的方法调用与关键字。

2、  多个参数用逗号隔开，每个逗号后都应加一个空格。

3、  除了 . 之外，所有的二元操作符都应用空格与它们的操作数隔开。一元操作符、++及--与操作    数间不需要空格。如

 

a += c + d;
a = (a + b) / (c * d);
while (d++ == s++)
{
n++;
}
PrintSize("size is " + size + "\n");

4、 语句中的表达式之间用空格隔开。如

 

for (expr1; expr2; expr3)

2.6   括号 - ()

1、 左括号“(” 不要紧靠关键字，中间用一个空格隔开。
2、 左括号“(”  与方法名之间不要添加任何空格。
3、 没有必要的话不要在返回语句中使用()。如

 

if (condition)
Array.Remove(1);
return 1;

2.7   花括号 - {}

1、 左花括号 “{” 放于关键字或方法名的下一行并与之对齐。如

 

if (condition)
{
}
public int Add(int x, int y)
{
}

2、左花括号 “{” 要与相应的右花括号 “}”对齐。
3、 通常情况下左花括号 “{”单独成行，不与任何语句并列一行。
4、 if、while、do语句后一定要使用{}，即使{}号中为空或只有一条语句。如

 

if (somevalue == 1)
{
somevalue = 2;
}

5、 右花括号 “}” 后建议加一个注释以便于方便的找到与之相应的 {。如

 

while (1)
{
if (valid)
{
} // if valid
    else
{
} // not valid

} // end forever

第三章 程序注释

3.4   注释概述

1、修改代码时，总是使代码周围的注释保持最新。

2、在每个例程的开始，提供标准的注释样本以指示例程的用途、假设和限制很有帮助。注释样本应该是解释它为什么存在和可以做什么的简短介绍.

3、避免在代码行的末尾添加注释；行尾注释使代码更难阅读。不过在批注变量声明时，行尾注释是合适的；在这种情况下，将所有行尾注释在公共制表位处对齐。 

4 、避免杂乱的注释，如一整行星号。而是应该使用空白将注释同代码分开。 

5 、避免在块注释的周围加上印刷框。这样看起来可能很漂亮，但是难于维护。

6 、在部署发布之前，移除所有临时或无关的注释，以避免在日后的维护工作中产生混乱。

7 、如果需要用注释来解释复杂的代码节，请检查此代码以确定是否应该重写它。尽一切可能不注释难以理解的代码，而应该重写它。尽管一般不应该为了使代码更简单以便于人们使用而牺牲性能，但必须保持性能和可维护性之间的平衡。

8 、在编写注释时使用完整的句子。注释应该阐明代码，而不应该增加多义性。 

9 、在编写代码时就注释，因为以后很可能没有时间这样做。另外，如果有机会复查已编写的代码，在今天看来很明显的东西六周以后或许就不明显了。

10 、避免多余的或不适当的注释，如幽默的不主要的备注。

11、 使用注释来解释代码的意图。它们不应作为代码的联机翻译。 

12、 注释代码中不十分明显的任何内容。

13 、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释，尤其是在团队环境中。

14 、对由循环和逻辑分支组成的代码使用注释。这些是帮助源代码读者的主要方面。 

15 、在整个应用程序中，使用具有一致的标点和结构的统一样式来构造注释。 

16 、用空白将注释同注释分隔符分开。在没有颜色提示的情况下查看注释时，这样做会使注释很明显且容易被找到。

17 、在所有的代码修改处加上修改标识的注释。

18 、为了是层次清晰，在闭合的右花括号后注释该闭合所对应的起点。

 

namespace Langchao.Procument.Web
{
} // namespace Langchao.Procument.Web

3.2   文档型注释

该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。如

 

///<summary>MyMethod is a method in the MyClass class.
///<para>Here's how you could make a second paragraph in a description.
///<see cref="System.Console.Writ