文档介绍：.
代码编写规范说明书（c#与）
目录
1 目的
2 范围
3 注释规范
概述
自建代码文件注释
模块（类）注释
类属性注释
方法注释
代码间注释
4 命名总体规则
5 命名规范
变量（ Variabl名
常量名也应当有一定的意义，格式为 NOUN或NOUN_VERB常量名均为大写，字之间用
下划线分隔。
例：
private const bool WEB_ENABLEPAGECACHE_DEFAULT = true;
private const int WEB_PAGECACHEEXPIRESINSECONDS_DEFAULT = 3600;
private const bool WEB_ENABLESSL_DEFAULT = false;
注：
变量名和常量名最多可以包含 255 个字符， 但是，超过 25 到 30 个字符的名称比较笨拙。 此外，要想取一个有实际意义的名称，清楚地表达变量或常量的用途， 25 或 30 个字符应 当足够了。
类(Class)命名
a) 名字应该能够标识事物的特性。
b) 名字尽量不使用缩写，除非它是众所周知的。
c) 名字可以有两个或三个单词组成，但通常不应多于三个。
d) 在名字中，所有单词第一个字母大写。例如 IsSuperUser,包含ID的，ID全部大写，如
CustomerID。
e) 使用名词或名词短语命名类。
f) 少用缩写。
g) 不要使用下划线字符 (_)。
例： public class FileStream
public class Button
public class String
接口( In terface)命名
和类命名规范相同，唯一区别是 接口在名字前加上"I”前缀
例：
interface IDBCommand;
interface IButton;
方法( Method )命名
和类命名规范相同。
命名空间(NameSpace)命名
和类命名规范相同。
6 编码规则
错误检查规则
a) 编程中要考虑函数的各种执行情况,尽可能处理所有流程情况。
b) 检查所有的系统调用的错误信息,除非要忽略错误。
c) 将函数分两类：一类为与屏幕的显示无关, 另一类与屏幕的显示有关。对于与屏幕显示 无关的函数, 函数通过返回值来报告错误。 对于与屏幕显示有关的函数, 函数要负责向用户 发出警告,并进行错误处理。
d) 错误处理代码一般放在函数末尾。
e) 对于通用的错误处理,可建立通用的错误处理函数,处理常见的通用的错误。 大括号规则
将大括号放置在关键词下方的同列处,例如：
if ($condition) while ($condition)
{ {
} }
缩进规则
使用一个“ Tab”为每层次缩进。例如：
function func()
{
if (something bad)
{
if (another thing bad)
{
while (more input)
{
}
}
}
}
小括号规则
a) 不要把小括号和关键词( if 、 while 等)紧贴在一起，要用空格隔开它们。
b) 不要把小括号和函数