微软编程规范(文档)
Posted 芜明-追星
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了微软编程规范(文档)相关的知识，希望对你有一定的参考价值。
项目编程规范
第一章 概述. 5
术语定义. 5
Pascal 大小写. 5
Camel 大小写. 5
文件命名组织. 5
1.3.1文件命名. 5
1.3.2文件注释. 5
第二章 代码外观. 7
2.1 列宽. 7
2.2 换行. 7
2.3 缩进. 7
2.4 空行. 7
2.5 空格. 8
2.6 括号 - () 8
2.7 花括号 - {} 9
第三章 程序注释. 10
3.1 注释概述. 10
3.2 文档型注释. 10
3.3 单行注释. 11
3.4 注释标签. 12
第四章 申明. 15
4.1 每行声明数. 15
4.2 初始化. 15
4.3 位置. 15
4.4 类和接口的声明. 16
4.5 字段的声明. 16
第五章 命名规范. 17
5.1 命名概述. 17
5.2 大小写规则. 18
5.3 缩写. 19
5.4 命名空间. 19
5.5 类. 19
5.6 接口. 20
5.7 属性 (Attribute) 21
5.8 枚举 (Enum) 21
5.9 参数. 21
5.10 方法. 21
5.11 属性 (property) 22
5.12 事件. 23
5.13 常量 (const) 24
5.14 字段. 25
5.15 静态字段. 26
5.16 集合. 26
5.17 措词. 26
第六章 语句. 28
6.1 每行一个语句. 28
6.2 复合语句. 28
6.3 return 语句. 28
6.4 if、 if-else、if else-if 语句. 28
6.4 for、foreach 语句. 29
6.5 while 语句. 30
6.7. do - while 语句. 30
6.8. switch - case 语句. 30
6.9. try - catch 语句. 31
6.10. using 块语句. 31
6.11. goto 语句. 31
第七章 控件命名规则. 32
7.1 命名方法. 32
7.2 主要控件名简写对照表. 32
第八章 代码格式检查. 33
8.1 检查分类. 33
8.2 安装及使用. 33
8.3 文档规则(Documentation Rules) 34
8.4 布局规则(LayoutRules) 42
8.5 可维护性规则(Maintanability Rules)”. 43
第九章 代码分析. 45
9.1.安全性规则. 45
9.2.可靠性规则. 45
9.3.可维护性规则. 45
9.4.命名规则. 46
9.5.性能规则. 46
9.6.用法规则. 46
第一章 概述
1.1术语定义
1.1.1 Pascal 大小写
将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如： BackColor
1.1.2 Camel 大小写
标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColor
第二章 代码外观
2.1 列宽
代码列宽控制在110字符左右。
2.2 换行
当表达式超出或即将超出规定的列宽，遵循以下规则进行换行
1、在逗号后换行;
2、在操作符前换行;
3、规则1优先于规则2。
2.3 缩进
缩进应该是每行一个Tab(4个空格)，不要在代码中使用Tab字符。
2.4 空行
空行是为了将逻辑上相关联的代码分块，以便提高代码的可阅读性。
在代码中，不能包含多个空行。
在以下情况下使用一个空行
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)
{
}
else
{
} // if
} // while
第三章 程序注释
3.1 注释概述
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 文件注释
在每个文件头必须包含以下注释说明
// <copyright file="文件名.cs" company="HP">
// Copyright (c) HP. All rights reserved.
// </copyright>
// <author>×××</author>
// <date> yyyy-mm-dd </date>
// <summary>文件功能描述</summary>
// <modify>
// 修改人：×××
// 修改时间：yyyy-mm-dd
// 修改描述：×××
// 版本：1.0
//</modify>
注意：文件功能描述只需简述，具体详情在类的注释中描述。创建标识和修改标识由创建或修改人员的拼音或英文名。如：Zhangsan。一天内有多个修改的只需做一个在注释说明中做一个修改标识就够了。在所有的代码修改处加上修改标识的注释。
3.3 文档型注释
该类注释采用.Net已定义好的Xml标签来标记，在声明接口、类、方法、属性、字段都应该使用该类注释，以便代码完成后直接生成代码文档，让别人更好的了解代码的实现和接口。如
1、 类、接口注释
/// <summary>
/// 类功能的说明
/// </summary>
/// <see cref=""></see>
/// <remarks>
/// 创建人：Zhangsan
/// 创建日期：yyyy-mm-dd
/// 修改人：Lisi
/// 修改日期：yyyy-mm-dd
/// 修改备注：无
/// 版本：1.0
/// </remarks>
public class CountersModuleInitializer : ModuleInitializer
{
}
注意：<see cref=""></see>标签根据具体情况选择有无
2、 方法、事件注释
/// <summary>
/// 根据员工编号获得员工信息
/// </summary>
/// <param name="employeeId">员工编号</param>
/// <exception cref="System.Exception">系统异常</exception>
/// <returns>员工姓名</returns>
/// <remarks>
/// 创建人：Zhangsan
/// 创建日期：yyyy-mm-dd
/// 修改人：Lisi
/// 修改日期：yyyy-mm-dd
/// 修改备注：无
/// 版本：1.1
/// </remarks>
public string GetEmployeeNameById(int employeeId)
{
try
{
return "ddd";
}
catch (System.Exception)
{
throw;
}
}
注意：该方法注释中的<param></param>、<exception cref=" "></exception>、<returns></returns>等标签根据具体情况选择有无，方法初始版本为1.0，每次改动增加0.1。
3、 属性、常量注释
/// <summary>
/// session id
/// </summary>
public const string SESSION_ID = "";
3.3 单行注释
该类注释用于
1 方法内的代码注释。如变量的声明、代码或代码段的解释。注释示例：
// 注释语句
private int number;
2 方法内变量的声明或花括号后的注释, 注释示例：
if ( 1 == 1) // always true
{
statement;
}
else // always false
{
}
3.4 javascript注释
a) 注释符号
‘//’
不允许使用‘/**/’作注释符。
b) 函数注释
每个函数都应该描述该函数的名称、功能、作用范围、入口参数的类型和传值方式及参数含义、返回值类型及返回值的含义。格式如下：
//
//Function: 函数名
//Purpose: 用途
//Scope: 作用范围
//Args: 入口参数(列表) 类型传值方式含义
//Returns: 返回值类型 (可确定值列表) 含义
//
c) 非函数注释
注明该模块的作用
格式如下：
//
//功能：
//
d) 程序行间注释
在程序行的每一个处理单元前作注释
格式如下：
//注释
e) 注释举例
//
//Function: F_FindObject
//Purpose: 按照空间名在可视化主对象中查找住对象内的可视化控件
//Scope: Public
//Args: is_name String value：要查找的空间名
// ipbo_object Object value: 可视化主对象
//Returns: Boolean True 表示找到该控件
// False 表示没有找到该控件
//
function F_FindObject(is_name, ipbo_object) {
//获得显示学生信息的GreeView控件
var gv_student = document.getElementById("GVStudent");
***********
//返回true
return true;
}
3.5 注释标签
|
标签 |
用法 |
作用 |
|
<c> |
c>text</c>
text 希望将其指示为代码的文本。 |
为您提供了一种将说明中的文本标记为代码的方法。使用 <code> 将多行指示为代码 |
|
<para> |
<para>content</para> content段落文本。 |
|
|
<param> |
<param name=‘name‘>description</param> name 为方法参数名。将此名称用单引号括起来 (‘ ‘)。 |
应当用于方法声明的注释中，以描述方法的一个参数。 |
|
<paramref>
|
<paramref name="name"/> name 要引用的参数名。将此名称用双引号括起来 (" ")。 |
<paramref> 标记为您提供了一种指示词为参数的方法。可以处理 XML 文件，从而用某种独特的方法格式化该参数。 |
|
<see> |
<see cref="member"/>
cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 (" ") 中。 |
使您得以从文本内指定链接。使用 <seealso> 指示希望在“请参阅”一节中出现的文本。 |
|
<seealso> |
<seealso cref="member"/> cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 传递给输出 XML 中的元素名。必须将 member 括在双引号 (" ") 中 |
使您得以指定希望在“请参阅”一节中出现的文本。使用 <see> 从文本 |
|
<example> |
<example>description</example> description 代码示例的说明。 |
使用 <example> 标记可以指定使用方法或其他库成员的示例。一般情况下，这将涉及到 <code> 标记的使用。 |
|
<code> |
<code>content</code> content 为希望将其标记为代码的文本。
|
记为您提供了一种将多行指示为代码的方法。使用 <c> 指示应将说明中的文本标记为代码 |
|
<summary> |
<summary>description</summary> 此处description 为对象的摘要。 |
应当用于描述类型成员。使用 <remarks> 以提供有关类型本身的信息。 |
|
<exception> |
<exception cref="member">description</exception> cref = "member" 对可从当前编译环境中获取的异常的引用。编译器检查到给定异常存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。 description 说明。 |
<exception> 标记使您可以指定类能够引发的异常。 |
|
<include> |
<include file=‘filename‘ path=‘tagpath[@name="id"]‘ /> filename 包含文档的文件名。该文件名可用路径加以限定。将 filename 括在单引号中 (‘ ‘)。 Tagpath：filename 中指向标记名的标记路径。将此路径括在单引号中 (‘ ‘)。 name 注释前边的标记中的名称说明符；名称具有一个 id。 id 位于注释之前的标记的 id。将此 id 括在双引号中 (" ")。 |
<include> 标记使您得以引用描述源代码中类型和成员的另一文件中的注释。这是除了将文档注释直接置于源代码文件中之外的另一种可选方法。 <include> 标记使用 XML XPath 语法。有关自定义 <include> 使用的方法，请参阅 XPath 文档。 |
|
<list> |
<list type="bullet" | "number" | "table"> <listheader> <term>term</term> <description>description</description> </listheader> <item> <term>term</term> <description>description</description> </item> </list>
term 定义的项，该项将在 text 中定义。 description 目符号列表或编号列表中的项或者 term 的定义。 |
<listheader> 块用于定义表或定义列表中的标题行。定义表时，只需为标题中的项提供一个项。 列表中的每一项用 <item> 块指定。创建定义列表时，既需要指定 term 也需要指定 text。但是，对于表、项目符号列表或编号列表，只需为 text 提供一个项。 列表或表所拥有的 <item> 块数可以根据需要而定。 |
|
<permission> |
<permission cref="member">description</permission>
cref = "member" 对可以通过当前编译环境进行调用的成员或字段的引用。编译器检查到给定代码元素存在后，将 member 转换为输出 XML 中的规范化元素名。必须将 member 括在双引号 (" ") 中。 description 成员的访问的说明。 |
<permission> 标记使您得以将成员的访问记入文档。System.Security.PermissionSet 使您得以指定对成员的访问。 |
|
<remarks> |
<remarks>description</remarks> description 成员的说明。 |
<remarks> 标记是可以指定有关类或其他类型的概述信息的位置。<summary> 是可以描述该类型的成员的位置。 |
|
<returns> |
<returns>description</returns> description 返回值的说明。 |
<returns> 标记应当用于方法声明的注释，以描述返回值。 |
|
<value> |
<value>property-description</value> property-description 属性的说明。 |
<value> 标记使您得以描述属性。请注意，当在 Visual Studio .NET 开发环境中通过代码向导添加属性时，它将会为新属性添加 <summary> 标记。然后，应该手动添加 <value> 标记以描述该属性所表示的值。 |
第四章 申明
4.1 每行声明数
一行只作一个声明,如
int level; //推荐
int size; //推荐
int x, y; //不推荐
4.2 初始化
建议在变量声明时就对其做初始化。
4.3 位置
变量建议置于块的开始处，不要总是在第一次使用它们的地方做声明。如
void MyMethod()
{
int int1 = 0; // beginning of method block
if (condition)
{
int int2 = 0; // beginning of "if" block
...
}
}
不过也有一个例外
for (int i = 0; i < maxLoops; i++)
{
...
}
应避免不同层次间的变量重名，如
int count;
...
void MyMethod()
{
if (condition)
{
int count = 0; // 避免
...
}
...
}
4.4 类和接口的声明
1 在方法名与其后的左括号间没有任何空格。
2 左花括号 “{” 出现在声明的下行并与之对齐，单独成行。
3 方法间用一个空行隔开。
4.5 字段的声明
不要使用是 public 或 protected 的实例字段。如果避免将字段直接公开给开发人员，可以更轻松地对类进行版本控制，原因是在维护二进制兼容性时字段不能被更改为属性。考虑为字段提供 get 和set 属性访问器，而不是使它们成为公共的。 get 和 set 属性访问器中可执行代码的存在使得可以进行后续改进，如在使用属性或者得到属性更改通知时根据需要创建对象。下面的代码示例阐释带有get 和 set 属性访问器的私有实例字段的正确使用。 示例：
public class Control: Component
{
private int handle;
public int Handle
{
get
{
return handle;
}
}
}
第五章 命名规范
5.1 命名概述
名称应该说明“什么”而不是“如何”。通过避免使用公开基础实现（它们会发生改变）的名称，可以保留简化复杂性的抽象层。例如，可以使用 GetNextStudent()，而不是 GetNextArrayElement()。
命名原则是：
选择正确名称时的困难可能表明需要进一步分析或定义项的目的。使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。表现力强的名称是为了帮助人们阅读；因此，提供人们可以理解的名称是有意义的。不过，请确保选择的名称符合适用语言的规则和标准。
以下几点是推荐的命名方法。
1、避免容易被主观解释的难懂的名称，如方面名 AnalyzeThis()，或者属性名 xxK8。这样的名称会导致多义性。
2、在类属性的名称中包含类名是多余的，如 Book.BookTitle。而是应该使用 Book.Title。
3、只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index）。
4、在变量名中使用互补对，如 min/max、begin/end 和 open/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 以便于维护和理解。
8、用于事件处理的委托添加“EventHandler”后缀
9、用于事件处理之外的那些委托添加“Callback”后缀
10、不要给委托添加“Delegate”后缀
11、用名词或名词词组来给类型命名，在少数情况下也可以用形容词词组来给类型命名
12、用动词或动词词组来命名方法
13、用名词、名词词组或形容词来命名属性
14、要用动词或动词短语来命名事件
15、要用名词或名词短语来命名字段
5.2 大小写规则
大写
标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：
System.IO
System.Web.UI
下表汇总了大写规则，并提供了不同类型的标识符的示例。
|
标识符 |
大小写 |
样例 |
|
名字空间 |
Pascal |
namespace System.Security{ … } |
|
类型 |
Pascal |
public class StreamReader{ … } |
|
接口 |
Pascal |
public interface IEnumerable{ … } |
|
方法 |
Pascal |
public class Object { public virtual string ToString(); } |
|
属性 |
Pascal |
public class String { public int Length{ get; } } |
|
事件 |
Pascal |
public class Process{ public event EventHandler Exited; } |
|
字段(私有实例) |
Camel |
private string userName； |
|
字段(公共静态) |
Pascal |
public static readonly string UserId; |
|
枚举 |
Pascal |
enum FileMode { Append, … } |
|
参数 |
Camel |
public class Convert { public static int ToInt32(string userId); } |
5.3 缩写
为了避免混淆和保证跨语言交互操作，请遵循有关区缩写的使用的下列规则：
1 不要将缩写或缩略形式用作标识符名称的组成部分。例如，使用 GetWindow，而不要使用 GetWin。
2 不要使用计算机领域中未被普遍接受的缩写。
3 在适当的时候，使用众所周知的缩写替换冗长的词组名称。例如，用 UI 作为 User Interface 缩
写，用 OLAP 作为 On-line Analytical Processing 的缩写。
4在使用缩写时，对于超过两个字符长度的缩写请使用 Pascal 大小写或 Camel 大小写。例如，使用 htmlButton 或 HTMLButton。但是，应当大写仅有两个字符的缩写，如，System.IO，而不是 System.Io。
5 不要在标识符或参数名称中使用缩写。如果必须使用缩写，对于由多于两个字符所组成的缩写请
使用Camel 大小写，虽然这和单词的标准缩写相冲突。
5.4 命名空间
1、给命名空间命名时的一般性规则是使用公司名称，后跟技术名称和可选的功能与设计，如下所示。
CompanyName.TechnologyName[.Feature][.Design]
例如：
namespace JadeBird.StudentManager //学员系统
namespace JadeBird.StudentManager.Register //北学员注册模块
2、命名空间使用Pascal大小写，用点号分隔。
3、TechnologyName 指的是该项目的英文缩写，或软件名。
4、命名空间和类不能使用同样的名字。例如，有一个类被命名为Debug后，就不要再使用Debug作为一个名称空间名。
5.5 文件命名
1 文件名遵从Pascal命名法，无特殊情况，扩展名小写。
2 使用统一而又通用的文件扩展名：
|
文件类型 |
扩展名 |
|
C#类 |
.cs |
|
Asp.net页面 |
.aspx |
|
… |
使用默认扩展名 |
5.6 类
1、使用 Pascal 大小写。
2、用名词或名词短语命名类。
3、使用全称避免缩写，除非缩写已是一种公认的约定，如URL、HTML
4 、不要使用类型前缀，如在类名称上对类使用 C 前缀。例如，使用类名称 FileStream，而不是
CFileStream。
5 、不要使用下划线字符 (_)。
6 、有时候需要提供以字母 I 开始的类名称，虽然该类不是接口。只要 I 是作为类名称组成部分的整个单词的第一个字母，这便是适当的。例如，类名称 IdentityStore 是适当的。在适当的地方，使用复合单词命名派生的类。派生类名称的第二个部分应当是基类的名称。例如，ApplicationException 对于从名为 Exception 的类派生的类是适当的名称，原因ApplicationException 是一种Exception。请在应用该规则时进行合理的判断。例如，Button 对于从 Control 派生的类是适当的名称。尽管按钮是一种控件，但是将 Control 作为类名称的一部分将使名称不必要地加长。
public class FileStream
public class Button
public class String
5.7 接口
以下规则概述接口的命名指南：
1、用名词或名词短语，或者描述行为的形容词命名接口。例如，接口名称 IComponent 使用描述性
名词。接口名称 ICustomAttributeProvider 使用名词短语。名称 IPersistable 使用形容词。
2、使用 Pascal 大小写。
3、少用缩写。
4、给接口名称加上字母 I 前缀，以指示该类型为接口。在定义类/接口对（其中类是接口的标准
实现）时使用相似的名称。两个名称的区别应该只是接口名称上有字母 I 前缀。
5、不要使用下划线字符 (_)。
6、当类是接口的标准执行时，定义这一对类/接口组合就要使用相似的名称。两个名称的不同之处
只是接口名前有一个I前缀。
以下是正确命名的接口的示例。
public interface IServiceProvider
public interface IFormatable
以下代码示例阐释如何定义 IComponent 接口及其标准实现 Component 类。
public interface IComponent
{
// Implementation code goes here.
}
public class Component: IComponent
{
// Implementation code goes here.
}
5.8 枚举 (Enum)
枚举 (Enum) 值类型从 Enum 类继承。以下规则概述枚举的命名指南：
1 对于 Enum 类型和值名称使用 Pascal 大小写。
2 少用缩写。
3 不要在 Enum 类型名称上使用 Enum 后缀。
4 对大多数 Enum 类型使用单数名称，但是对作为位域的 Enum 类型使用复数名称。
5 总是将 FlagsAttribute 添加到位域 Enum 类型。
6不要命名“Reserved”枚举值。
5.9 参数
以下规则概述参数的命名指南：
1、使用描述性参数名称。参数名称应当具有足够的描述性，以便参数的名称及其类型可用于在大多数情况下确定它的含义。
2、对参数名称使用 Camel 大小写。
3、 使用描述参数的含义的名称，而不要使用描述参数的类型的名称。开发工具将提供有关参数的类型的有意义的信息。因此， 通过描述意义，可以更好地使用参数的名称。少用基于类型的参数名称，仅在适合使用它们的地方使用它们。
4、不要使用保留的参数。保留的参数是专用参数，如果需要，可以在未来的版本中公开它们。相反，如果在类库的未来版本中需要更多的数据，请为方法添加新的重载。
5、不要给参数名称加匈牙利语类型表示法的前缀。
以下是正确命名的参数的示例。
Type GetType(string typeName)
string Format(string format, args() As object)
5.10 方法
以下规则概述方法的命名指南：
1 使用动词或动词短语命名方法。
2 使用 Pascal 大小写。
3 以下是正确命名的方法的实例。
RemoveAll()
GetCharArray()
Invoke()
5.11 属性 (property)
以下规则概述属性的命名指南：
1 使用名词或名词短语命名属性。
2 使用 Pascal 大小写。
3 不要使用匈牙利语表示法。
4 考虑用与属性的基础类型相同的名称创建属性。例如，如果声明名为 Color 的属性，则属
性的类型同样应该是 Color。请参阅本主题中后面的示例。
以下代码示例阐释正确的属性命名。
public class SampleClass
{
public Color BackColor
{
// Code for Get and Set accessors goes here.
}
}
以下代码示例阐释提供其名称与类型相同的属性。
public enum Color
{
// Insert code for Enum here.
}
public class Control
{
public Color Color
{
get
{
// Insert code here.
}
set
{
// Insert code here.
}
}
}
以下代码示例不正确，原因是 Color 属性是 Int 类型的。
public enum Color
{
// Insert code for Enum here.
}
public class Control
{
public int Color
{
// Insert code here
}
}
在不正确的示例中，不可能引用 Color 枚举的成员。Color.Xxx 将被解释为访问一个成员，
该成员首先获取 Color 属性（ C# 中为 int 类型）的值，然后再访问该值的某个成员（该成
员必须是 System.Int32 的实例成员）。
5.12 事件
以下规则概述事件的命名指南：
1、对事件处理程序名称使用 EventHandler 后缀。
2、指定两个名为 sender 和 e 的参数。sender 参数表示引发事件的对象。sender 参始
终是object 类型的，即使在可以使用更为特定的类型时也如此。与事件相关联的状态封装
在名为 e 的事件类的实例中。对 e 参数类型使用适当而特定的事件类。
3、用 EventArgs 后缀命名事件参数类。
4、考虑用动词命名事件。
5、使用动名词（动词的“ing”形式）创建表示事件前的概念的事件名称，用过去式表示事
件后。例如，可以取消的 Close 事件应当具有 Closing 事件和 Closed 事件。不要使用
BeforeXxx/AfterXxx 命名模式。
6、不要在类型的事件声明上使用前缀或者后缀。例如，使用 Close，而不要使用 OnClose。
7、通常情况下，对于可以在派生类中重写的事件，应在类型上提供一个受保护的方法（称为
OnXxx）。此方法只应具有事件参数 e，因为发送方总是类型的实例。
以下示例阐释具有适当名称和参数的事件处理程序。
public delegate void MouseEventHandler(object sender, MouseEventArgs e);
以下示例阐释正确命名的事件参数类。
public class MouseEventArgs : EventArgs
{
int x;
int y;
public MouseEventArgs(int x, int y)
{
this.x = x;
this.y = y;
}
public int X
{
get
{
return x;
}
}
public int Y
{
get
{
return y;
}
}
}
5.13 常量 (const)
以下规则概述常量的命名指南：
所有单词大写，多个单词之间用 "_" 隔开。 如
public const string PAGE_TITLE = "Welcome";
5.14 字段
以下规则概述字段的命名指南：
1、private、protected 使用 Camel 大小写。
2、public 使用 Pascal 大小写。
3、拼写出字段名称中使用的所有单词。仅在开发人员一般都能理解时使用缩写。字段名称不
要使用大写字母。下面是正确命名的字段的示例。
class SampleClass
{
string url;
string destinationUrl;
}
4、不要对字段名使用匈牙利语表示法。好的名称描述语义，而非类型。
5、不要对字段名或静态字段名应用前缀。具体说来，不要对字段名称应用前缀来区分静态和非静态字段。例如，应用 g_ 或 s_ 前缀是不正确的。
6、对预定义对象实例使用公共静态只读字段。如果存在对象的预定义实例，则将它们声明为
对象本身的公共静态只读字段。使用 Pascal 大小写，原因是字段是公共的。下面的代码
示例阐释公共静态只读字段的正确使用。
public struct Color
{
public static readonly Color Red = new Color(0x0000FF);
public Color(int rgb)
{
// Insert code here.}
public Color(byte r, byte g, byte b)
{
// Insert code here.
}
public byte RedValue
{
get
{
return Color;
}
}
}
5.15 静态字段
以下规则概述静态字段的命名指南：
1、使用名词、名词短语或者名词的缩写命名静态字段。
2、使用 Pascal 大小写。
3、对静态字段名称使用匈牙利语表示法前缀。
4、建议尽可能使用静态属性而不是公共静态字段。
5.16 集合
集合是一组组合在一起的类似的类型化对象，如哈希表、查询、堆栈、字典和列表，集合的命名
建议用复数。
5.17 措词
避免使用与常用的 .NET 框架命名空间重复的类名称。例如，不要将以下任何名称用作类名称：
System、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 |
Cint |
Class |
|
CLng |
CObj |
Const |
Cshort |
CSng |
|
CStr |
CType |
Date |
Decimal |
Declare |
|
Default |
Delegate |
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 |
Namespace |
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 |
|
|
第六章 语句
6.1 每行一个语句
每行最多包含一个语句。如
a++; //推荐
b--; //推荐
a++; b--; //不推荐
6.2 复合语句
复合语句是指包含"父语句{子语句;子语句;}"的语句，使用复合语句应遵循以下几点
1 子语句要缩进。
2 左花括号“{” 在复合语句父语句的下一行并与之对齐，单独成行。
3 即使只有一条子语句要不要省略花括号“ {}”。 如
while (d + = s++)
{
n++;
}
6.3 return 语句
return语句中不使用括号，除非它能使返回值更加清晰。如
return;
return myDisk.size();
return (size ? size : defaultSize);
6.4 if、 if-else、if else-if 语句
if、 if-else、if else-if 语句使用格式
if (condition)
{
statements;
}
if (condition)
{
statements;
}
else
{
statements;
}
if (condition)
{
statements;
}
else if (condition)
{
statements;
}
else
{
statements;
}
6.4 for、foreach 语句
for 语句使用格式
for (initialization; condition; update)
{
statements;
}
空的 for 语句（所有的操作都在initialization、condition 或 update中实现）使用格式
for (initialization; condition; update); // update user id
foreach 语句使用格式
foreach (object obj in array)
{
statements;
}
注意1在循环过程中不要修改循环计数器。
2对每个空循环体给出确认性注释。
6.5 while 语句
while 语句使用格式
while (condition)
{
statements;
}
空的 while 语句使用格式
while (condition);
6.7. do - while 语句
do - while 语句使用格式
do
{
statements;
} while (condition);
6.8. switch - case 语句
switch - case 语句使用格式
switch (condition)
{
case 1:
statements;
break;
case 2:
statements;
break;
default:
statements;
break;
}
注意：
1、语句switch中的每个case各占一行。
2、语句switch中的case按字母顺序排列。
3、为所有switch语句提供default分支。
4、所有的非空 case 语句必须用 break; 语句结束。
6.9. try - catch 语句
try - catch 语句使用格式
try
{
statements;
}
catch (ExceptionClass e)
{
statements;
}
finally
{
statements;
}
6.10. using 块语句
using 块语句使用格式
using (object)
{
statements;
}
6.11. goto 语句
goto 语句使用格式
goto Label1:
statements;
Lable1:
statements;
第七章 控件命名规则
7.1 命名方法
控件名简写+英文描述，英文描述首字母大写
7.2 主要控件名简写对照表
|
控件名 |
简写 |
控件名 |
简写 |
|
Label |
lbl |
TextBox |
txt |
|
Button |
btn |
LinkButton |
lnkbtn |
|
ImageButton |
imgbtn |
DropDownList |
ddl |
|
ListBox |
lst |
DataGrid |
dg |
|
DataList |
dl |
CheckBox |
chk |
|
CheckBoxList |
chkls |
RadioButton |
rdo |
|
RadioButtonList |
rdolt |
Image |
img |
|
Panel |
pnl |
Calender |
cld |
|
AdRotator |
ar |
Table |
tbl |
|
RequiredFieldValidator |
rfv |
CompareValidator |
cv |
|
RangeValidator |
rv |
RegularExpressionValidator |
rev |
|
ValidatorSummary |
vs |
CrystalReportViewer |
rptvew |
第八章 代码格式检查
代码格式检查使用微软内部代码检查工具 StyleCop 版本4.3.2.1，它会根据预定义的C#代码格式的最佳实践，对源代码进行检查，并给出不符合编码风格的错误提示（版本语言英文）。
8.1 检查分类
检查规则分为7个部分，分别是
“文档规则(Documentation Rules)”
“布局规则(LayoutRules)”
“可维护性规则(Maintanability Rules)”
“命名规则(Naming Rules)”
“代码顺序规则(Ordering Rules)”
“可读性规则(Readability Rules)”
“间距规则(Spacing Rules)”
8.2 安装及使用
安装：安装程序位于附件，Install文件夹中。该软件属于Visual Studio插件，安装后在工具菜单栏中。
使用：运行该功能后，可以根据“错误列表”中的警告信息的信息Id，从帮助文件（位于附件，Document文件夹中，文件名StyleCop.chm）找到相应编码格式，进行修复。
开发文档：位于附件，Document文件夹中，文件名StyleCopSDK.chm）
对于以下情况 “是否检查”一项中为“√”的内容不能违反。
8.3 文档规则(Documentation Rules)
|
标识及提示 |
中文及示例 |
是否检查 |
|
SA1600: ElementsMustBeDocumented |
元素必须被注释 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1601: PartialElementsMustBeDocumented |
部分元素必须被注释 /// <summary> /// Documentation for the first part of Class1. /// </summary> public partial class Class1 { }
/// <summary> /// Documentation for the second part of Class1. /// </summary> public partial class Class1 { } |
√ |
|
SA1602: EnumerationItemsMustBeDocumented |
枚举项必须被注释 /// <summary> /// Types of animals. /// </summary> public enum Animals { /// <summary> /// Represents a dog. /// </summary> Dog,
/// <summary> /// Represents a cat. /// </summary> Cat,
/// <summary> /// Represents a horse. /// </summary> Horse } |
√ |
|
SA1603: DocumentationMustContainValidXml |
文档必须包含有效的XML注释 /// <summary> /// An example of badly formed Xml. /// </summa3ry> public class Example { } |
√ |
|
SA1604: ElementDocumentationMustHaveSummary |
文档注释必须包含Summary /// <summary> /// Represents a customer in the database. /// </summary> public class Customer { } |
√ |
|
SA1605: PartialElementDocumentationMustHaveSummary |
部分文档注释必须包含Summary /// <summary> /// Documentation for the first part of Class1. /// </summary> public partial class Class1 { }
/// <summary> /// Documentation for the second part of Class1. /// </summary> public partial class Class1 { } |
√ |
|
SA1606: ElementDocumentationMustHaveSummaryText |
文档注释Summary必须有内容 /// <summary> </summary> /// <param name="customerId">The ID of the customer to find.</param> /// <returns>The customer, or null if the customer could not be /// found.</returns> public Customer FindCustomer(int customerId) { // ... finds the customer ... } |
√ |
|
SA1607: PartialElementDocumentationMustHaveSummaryText |
部分文档注释Summary必须有内容 /// <summary> </summary> /// <param name="customerId">The ID of the customer to find.</param> /// <returns>The customer, or null if the customer could not be found.</returns> public Customer FindCustomer(int customerId) { // ... finds the customer ... }
修复代码 /// <summary>Attempts to locate a record for the customer with the given ID.</summary> /// <param name="customerId">The ID of the customer to find.</param> /// <returns>The customer, or null if the customer could not be found.</returns> public Customer FindCustomer(int customerId) { // ... finds the customer ... } |
√ |
|
SA1608: ElementDocumentationMustNotHaveDefaultSummary |
文档注释不能有默认的Summary /// <summary> /// Summary description for the Example class. /// </summary> public class Example { } |
√ |
|
SA1609: PropertyDocumentationMustHaveValue |
属性注释必须有值 /// <summary> /// Gets the name of the customer. /// </summary> /// <value>The name of the customer.</value> public bool Name { get { return this.name; } } |
√ |
|
SA1610: PropertyDocumentationMustHaveValueText |
属性注释必须有值内容 /// <summary> /// Gets the name of the customer. /// </summary> /// <value>The name of the customer.</value> public bool Name { get { return this.name; } } |
√ |
|
SA1611: ElementParametersMustBeDocumented |
元素的参数必须注释 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1612: ElementParameterDocumentationMustMatchElementParameters |
元素的参数注释必须与元素参数成对 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1613: ElementParameterDocumentationMustDeclareParameterName |
元素的参数注释必须定义参数名 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1614: ElementParameterDocumentationMustHaveText |
元素的参数注释必须有值 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1615: ElementReturnValueMustBeDocumented |
元素的返回值必须被注释 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1616: ElementReturnValueDocumentationMustHaveValue |
元素的返回值注释必须有值 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1617: VoidReturnValueMustNotBeDocumented |
元素空返回值不能注释 /// <summary> /// Prints the given name. /// </summary> /// <param name="firstName">The first name.</param> /// <param name="lastName">The last name.</param> public void PrintNames(string firstName, string lastName) { Console.WriteLine(firstName + " " + lastName); } |
√ |
|
SA1618: GenericTypeParametersMustBeDocumented |
泛型参数必须被注释 /// <summary> /// A sample generic class. /// </summary> /// <typeparam name="S">The first generic type parameter.</typeparam> /// <typeparam name="T">The second generic type parameter.</typeparam> public class Class1<S, T> { } |
√ |
|
SA1619: GenericTypeParametersMustBeDocumentedPartialClass |
泛型参数在部分类中必须被注释 /// <summary> /// A sample generic class. /// </summary> /// <typeparam name="S">The first generic type parameter.</typeparam> /// <typeparam name="T">The second generic type parameter.</typeparam> public class Class1<S, T> { } |
√ |
|
SA1620: GenericTypeParameterDocumentationMustMatchTypeParameters |
泛型参数注释必须与参数类型对应 /// <summary> /// A sample generic class. /// </summary> /// <typeparam name="S">The first generic type parameter.</typeparam> /// <typeparam name="T">The second generic type parameter.</typeparam> public class Class1<S, T> { } |
√ |
|
SA1621: GenericTypeParameterDocumentationMustDeclareParameterName |
泛型参数注释必须定义参数名 /// <summary> /// A sample generic class. /// </summary> /// <typeparam name="S">The first generic type parameter.</typeparam> /// <typeparam name="T">The second generic type parameter.</typeparam> public class Class1<S, T> { } |
√ |
|
SA1622: GenericTypeParameterDocumentationMustHaveText |
泛型参数注释必须有内容 /// <summary> /// A sample generic class. /// </summary> /// <typeparam name="S">The first generic type parameter.</typeparam> /// <typeparam name="T">The second generic type parameter.</typeparam> public class Class1<S, T> { } |
√ |
|
SA1623: PropertySummaryDocumentationMustMatchAccessors |
属性摘要文档必须和访问者对应 (参考帮助文档) |
√ |
|
SA1624: PropertySummaryDocumentationMustOmitSetAccessorWithRestricedAccess |
属性摘要文档必须必须省略设置访问器约束访问 (参考帮助文档) |
√ |
|
SA1625: ElementDocumentationMustNotBeCopiedAndPasted |
元素注释不能被拷贝和粘贴 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1626: SingleLineCommentsMustNotUseDocumentationStyleSlashes |
单行注释不能使用斜线样式 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">Part of the name.</param> /// <param name="lastName">Part of the name.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { A legal comment beginning with two slashes: // Join the names together. string fullName = firstName + " " + lastName;
An illegal comment beginning with three slashes: /// Trim the name. fullName = fullName.Trim();
A line of commented-out code beginning with four slashes: ////fullName = asfd;
return fullName; } |
√ |
|
SA1627: DocumentationTextMustNotBeEmpty |
注释内容不能为空 /// <summary> /// Joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName"> </param> /// <param name="lastName">Part of the name.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { ... } |
√ |
|
SA1628: DocumentationTextMustBeginWithACapitalLetter |
注释内容首字母必须大写 /// <summary> /// joins a first name and a last name together into a single string. /// </summary> /// <param name="firstName">The first name.</param> /// <param name="lastName">The last name.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { ... } |
√ |
|
SA1629: DocumentationTextMustEndWithAPeriod |
注释内容必须用句号结尾 /// <summary> /// Joins a first name and a last name together into a single string /// </summary> /// <param name="firstName">The first name.</param> /// <param name="lastName">The last name.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { ... } |
√ |
|
SA1630: DocumentationTextMustContainWhitespace |
注释内容单词之间必须包含空白符 /// <summary> /// Joinsnames /// </summary> /// <param name="firstName">First</param> /// <param name="lastName">Last</param> /// <returns>Name</returns> public string JoinNames(string firstName, string lastName) { ... } |
|
|
SA1631: DocumentationTextMustMeetCharacterPercentage |
注释内容必须满足字符比例特殊字符不能过多 /// <summary> /// @)$(*A name-------- /// </summary> public class Name { ... } |
|
|
SA1632: DocumentationTextMustMeetMinimumCharacterLength |
注释内容必须满足小写字符长度 /// <summary> /// A name /// </summary> public class Name { ... } |
√ |
|
SA1633: FileMustHaveHeader |
文件必须有文件头部注释 //----------------------------------------------------------------------- // <copyright file="NameOfFile.cs" company="CompanyName"> // Company copyright tag. // </copyright> //-----------------------------------------------------------------------
For example, a file called Widget.cs from a fictional company called Sprocket Enterprises should contain a file header similar to the following: //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //-----------------------------------------------------------------------
The dashed lines at the top and bottom of the header are not strictly necessary, so the header could be written as: // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright>
It is possible to add additional tags, although they will not be checked or enforced by StyleCop: //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> // <author>John Doe</author> //----------------------------------------------------------------------- |
√ |
|
SA1634: FileHeaderMustShowCopyright |
文件头部注释必须显示版权信息标识 //----------------------------------------------------------------------- // <Tag>A file header which does not contain a copyright tag</Tag> //-----------------------------------------------------------------------
A file header should include a copyright tag, as follows: //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //----------------------------------------------------------------------- |
√ |
|
SA1635: FileHeaderMustHaveCopyrightText |
文件头部注释必须有版权信息表示内容 //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // </copyright> //-----------------------------------------------------------------------
A file header should include copyright text, as follows: //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //----------------------------------------------------------------------- |
√ |
|
SA1636: FileHeaderMustContainFileName |
文件头部注释必须包含文件名 //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="My Company"> // Custom company copyright tag. // </copyright> //----------------------------------------------------------------------- |
√ |
|
SA1637: FileHeaderMustContainFileName |
文件头部注释必须包含文件名 //----------------------------------------------------------------------- // <copyright company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //-----------------------------------------------------------------------
//----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //----------------------------------------------------------------------- |
√ |
|
SA1638: FileHeaderFileNameDocumentationMustMatchFileName |
文件头部注释文件名注释必须与文件名对应 //----------------------------------------------------------------------- // <copyright file="File2.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //-----------------------------------------------------------------------
A violation of this rule would occur, since the file tag does not contain the name of the file. The header should be written as: //----------------------------------------------------------------------- // <copyright file="File1.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //----------------------------------------------------------------------- |
√ |
|
SA1639: FileHeaderMustHaveSummary |
文件头部注释不许有摘要 //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //-----------------------------------------------------------------------
If this rule is enabled, the file header should contain a summary tag. For example: //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> // <summary>Defines the Widget class.</summary> //----------------------------------------------------------------------- |
√ |
|
SA1640: FileHeaderMustHaveValidCompanyText |
文件头部注释必须有正确的公司信息 //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="Sprocket Enterprises"> // Copyright (c) Sprocket Enterprises. All rights reserved. // </copyright> //----------------------------------------------------------------------- |
√ |
|
SA1641: FileHeaderCompanyNameTextMustMatch |
文件头部注释公司内容必须对应 //----------------------------------------------------------------------- // <copyright file="Widget.cs" company="My Company"> // Custom company copyright tag. // </copyright> //----------------------------------------------------------------------- |
√ |
|
SA1642: ConstructorSummaryDocumentationMustBeginWithStandardText |
构造器的Summary注释必须由标准内容开始 (参考帮助文档) |
√ |
|
SA1643: DestructorSummaryDocumentationMustBeginWithStandardText |
析构器的Summary注释必须由标准内容开始 /// <summary> /// Initializes a new instance of the <see cref="Customer`1"/> class. /// </summary> public Customer() { }
/// <summary> /// Initializes a new instance of the <see cref="Customer{T}"/> class. /// </summary> public Customer() { } |
√ |
|
SA1644: DocumentationHeadersMustNotContainBlankLines |
注释头部不能包含空白行 /// <summary> /// <para> /// Joins a first name and a last name together into a single string. /// </para><para> /// Uses a simple form of string concatenation. /// </para> /// </summary> /// <param name="firstName">The first name to join.</param> /// <param name="lastName">The last name to join.</param> /// <returns>The joined names.</returns> public string JoinNames(string firstName, string lastName) { return firstName + " " + lastName; } |
√ |
|
SA1645: IncludedDocumentationFileDoesNotExist |
导入的文档注释文件不存在 ///<include file="IncludedDocumentation.xml" path="root/EnabledMethodDocs" /> public bool Enabled(bool true) { }
|
√ |
|
SA1646: IncludedDocumentationXPathDoesNotExist |
导入的文档注释的XPath不存在 ///<include file="IncludedDocumentation.xml" path="root/EnabledMethodDocs" /> public bool Enabled(bool true) { } |
√ |
|
SA1647: IncludeNodeDoesNotContainValidFileAndPath |
导入的结点不存在正确的文件和路径 ///<include file="IncludedDocumentation.xml" path="root/EnabledMethodDocs" /> public bool Enabled(bool true) { } |
√ |
8.4 布局规则(LayoutRules)
|
标识及提示 |
中文及示例 |
是否检查 |
|
SA1500: CurlyBracketsForMultiLineStatementsMustNotShareLine |
当多行代码使用{}时"{" 与 "}"必须单独占一行 |
√ |
|
SA1501: StatementMustNotBeOnSingleLine |
{}不能与代码写在同一行 |
√ |
|
SA1502: ElementMustNotBeOnSingleLine |
元素定义不能在同一行 |
√ |
|
SA1503: CurlyBracketsMustNotBeOmitted |
{}符号不能被省略 |
√ |
|
SA1504: AllAccessorMustBeMultiLineOrSingleLine |
所有的访问器代码，必须是多行或一行(不能Get多行，Set单行) |
√ |
|
SA1505: OpeningCurlyBracketsMustNotBeFollowedByBlankLine |
{ 符号下面不能跟空行 |
√ |
|
SA1506: ElementDocumentationHeadersMustNotBeFollowedByBlankLine |
元素注释头部不能跟空行 |
√ |
|
SA1507: CodeMustNotContainMultipleBlankLinesInARow |
代码不能包含连续的多个空行 |
√ |
|
SA1508: ClosingCurlyBracketsMustNotBePrecededByBlankLine |
} 符号上方不能有空行 |
√ |
|
SA1509: OpeningCurlyBracketsMustNotBePrecedededByBlankLine |
{ 符号与代码之间不能有空行 |
√ |
|
SA1510: ChainedStatementBlocksMustNotBePrecededByBlankLine |
使用 {} 符号并且连接的代码之间不能有空行 |
√ |
|
SA1511: WhileDoFooterMustNotBePrecededByBlankLine |
Do While代码之间不能有空行 |
√ |
|
SA1512: SingleLineCommentsMustNotBeFollowedByBlankLine |
单行注释与代码之间不能有空行 |
√ |
|
SA1513: ClosingCurlyBracketMustBeFollowedByBlankLine |
} 符号后面必须有空行 |
√ |
|
SA1514: ElementDocumentationHeaderMustBePrecededByBlankLine |
元素注释头部必须加空行 |
√ |
|
SA1515: SingleLineCommentMustBePrecededByBlankLine |
单行注释前面必须加空行 |
√ |
|
SA1516: ElementsMustBeSeparatedByBlankLine |
元素必须用空行分隔 |
√ |
8.5 可维护性规则(Maintanability Rules)”
|
标识及提示 |
中文及示例 |
是否检查 |
|
SA1300: ElementMustBeginWithUpperCaseLetter |
元素必须首字母大写 |
√ |
|
SA1301: ElementMustBeginWithLowerCaseLetter |
元素必须首字母小写 |
√ |
|
SA1302: InterfaceNamesMustBeginWithI |
命名接口必须以I开头 |
√ |
|
SA1303: ConstFieldNamesMustBeginWithUpperCaseLetter |
常量字段命名必须首字母大写 |
√ |
|
SA1304: NonPrivateReadonlyFieldsMustBeginWithUpperCaseLetter |
非私有只读字段必须首字母大写 |
√ |
|
SA1305: FieldNamesMustNotUseHungarianNotation |
字段名不能使用匈牙利命名法 |
√ |
|
SA1306: FieldNamesMustBeginWithLowerCaseLetter |
字段名必须首字母小写 |
√ |
|
SA1307: AccessibleFieldsMustBeginWithUpperCaseLetter |
可访问字段必须首字母大写 |
√ |
|
SA1308: VariableNamesMustNotBePrefixed |
变量名不能加前缀 |
√ |
|
SA1309: FieldNamesMustNotBeginWithUnderscore |
字段名不能以"_"开头 |
√ |
|
SA1310: FieldNamesMustNotContainUnderscore |
字段名不能包含"_" |
√ |
第九章 代码分析
使用Visual Studio自身的代码分析功能，检查内容如下表，分为
1.安全规则。
2.互操作性规则
3.可维护性规则
4.可以只性规则
5.命名规则
6.全球化规则
7.设计规则
8.性能规则
9.移动性规则
10.用法规则
其中“是否检查”一项中为“√”的内容不能违反。需在Visual Studio中设置为错误
9.1.安全性规则
|
标识 |
详细信息 |
是否检查 |
|
CA2100 |
检查Sql查询中是否有安全漏洞 |
√ |
|
CA2104 |
不要声明只读可变引用类型 |
√ |
|
CA2105 |
数组字段不应为只读 |
√ |
|
CA2121 |
静态构造函数应为私有 |
√ |
9.2.可靠性规则
|
标识 |
详细信息 |
是否检查 |
|
CA2000 |
超出范围前释放对象 |
√ |
9.3.可维护性规则
|
标识 |
详细信息 |
是否检查 |
|
CA1500 |
变量名不应与字段名相同 |
√ |
|
CA1501 |
避免过度继承 |
√ |
|
CA1502 |
避免过度复杂 |
√ |
9.4.命名规则
|
标识 |
详细信息 |
是否检查 |
|
CA1700 |
不要将枚举值命名为“Reserved” |
√ |
|
CA1705 |
较长的首字母缩略词应采用Pascal大小写格式。 |
√ |
|
CA1706 |
较短的首字母缩略词应全部大写 |
√ |
|
CA1707 |
标识符不应包含下划线 |
√ |
|
CA1709 |
标识符的大小写应该正确 |
√ |
|
CA1710 |
标识符应具有正确的后缀 |
√ |
|
CA1711 |
标识符应采用正确的后缀 |
√ |
|
CA1712 |
不要将类型名用作枚举值的前缀 |
√ |
|
CA1713 |
事件不应具有 before 或 after 前缀 |
√ |
|
CA1715 |
标识符应具有正确的前缀 |
√ |
|
CA1716 |
标识符不应与关键字冲突 |
√ |
|
CA1718 |
避免在参数中使用特定于语言的类型名 |
√ |
|
CA1719 |
参数名不应与成员名冲突 |
√ |
|
CA1720 |
标识符不应包含类型名 |
√ |
|
CA1721 |
属性名不应与 get 方法冲突 |
√ |
|
CA1722 |
标识符应采用正确的前缀 |
√ |
|
CA1724 |
类型名不应与命名空间冲突 |
√ |
|
CA1725 |
参数名应与基方法中的声明保持一致 |
√ |
9.5.性能规则
|
标识 |
详细信息 |
是否检查 |
|
CA1800 |
避免进行不必要的强制转换 |
√ |
|
CA1804 |
移除未使用的局部变量 |
√ |
|
CA1805 |
避免进行不必要的初始化 |
√ |
|
CA1809 |
避免过多的局部变量 |
√ |
|
CA1812 |
避免未实例化的内部类 |
√ |
|
CA1813 |
避免未密封的属性 |
√ |
|
CA1819 |
属性不应返回数组 |
√ |
|
CA1823 |
避免未使用的私有字段 |
√ |
9.6.用法规则
|
标识 |
详细信息 |
是否检查 |
|
CA1801 |
检查未使用的参数 |
√ |
|
CA2202 |
不要多次释放对象 |
√ |
|
CA2211 |
非常数字段不应该是可见的 |
√ |
|
CA2218 |
重写 Equals 时重写 GetHashCode |
√ |
|
CA2219 |
不要在异常子句中引发异常 |
√ |
|
CA2222 |
不要降低继承成员的可见性 |
√ |
|
CA2230 |
对个数可变的参数使用 params |
√ |
|
CA2233 |
运算不应溢出 |
√ |
以上是关于微软编程规范(文档)的主要内容，如果未能解决你的问题，请参考以下文章