c#开发规范.doc

C#开发规范
版本
更新时间
修改人
备注

2016
wp
目录
术语 3
文件命名 3
代码外观 4
程序注释 6
对象声明 8
代码规范 9
命名规范 9
语句规范 17
开发建议 20
术语
Pascal 大小写:将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal 大小写。例如:BackColor
Camel 大小写:标识符的首字母小写,而每个后面连接的单词的首字母都大写。例如: backColor
文件命名
文件名遵从Pascal命名法,无特殊情况,扩展名小写。
文件开始包含类似以下注释说明
/********************************************
// 文件名:
// 文件功能描述:
// 创建人:
// 创建时间:
// 描述:
// 修改人:
// 修改时间:
// 修改描述:
//******************************************/
文件功能描述着重于描述文件功能与说明,详情应在类的注释中描述。
一天内有多个修改只需做做一个修改标识,在所有的代码修改处加上修改标识的注释。
代码外观
列宽
代码列宽控制在100字符左右。
代码换行,换行后的代码应该缩进一个Tab。
换行
当表达式超出或即将超出规定的列宽,遵循以下规则进行换行
在逗号后换行。
在操作符前换行。
规则1优先于规则2。
当以上规则会导致代码混乱的时候自己采取更灵活的换行规则。
缩进
缩进应该是每行一个Tab(4个空格),不要在代码中使用Tab字符。
空行
在以下情况下使用两个空行
接口和类的定义之间。
枚举和类的定义之间。
类与类的定义之间。
在以下情况下使用一个空行
方法与方法、属性与属性之间。
方法中变量声明与语句之间。
方法与方法之间。
方法中不同的逻辑块之间。
方法中的返回语句与其他的语句之间。
属性与方法、属性与字段、方法与字段之间。
注释与它注释的语句间无空行,但与其他的语句空一行。
空格
在以下情况中要使用到空格
关键字和左括号(应该用空格隔开。
在方法名和左括号( 之间不要使用空格。
多个参数用逗号隔开,每个逗号后都应加一个空格。
除了. 之外,所有的二元操作符都应用空格与它们的操作数隔开。
一元操作符、++及--与操作数间不需要空格。
语句中的表达式之间用空格隔开。如for (expr1; expr2; expr3)
括号
左括号(不要紧靠关键字,中间用一个空格隔开。
左括号(与方法名之间不要添加任何空格。
没有必要的话不要在返回语句中使用()。
花括号
左花括号{放于关键字或方法名的下一行并与之对齐。
左花括号{要与相应的右花括号}对齐。
通常情况下左花括号{单独成行,不与任何语句并列一行。
if、while、do、for语句后一定要使用{},即使{}号中为空或只有一条语句。
右花括号} 后加一个注释以便于方便的找到与之相应的{。
块语句
将大的复杂代码节分为较小的、易于理解的模块。
当一行被分为几行时,将运算符放在行的末尾,标识行是不完整的。
在代码中垂直对齐左括号和右括号。
if (x == 0)
{
}
不允许以下情况:
if (x == 0) {
}
if (x == 0){ xxx;}
程序注释
注释原则
注释应该是解释为什么和做什么,而不是介绍是什么。
修改代码时,总是使代码周围的注释保持最新。
变量声明时,使用行尾注释是合适的;其他情况下,使用单行注释。
避免杂乱的注释,如一整行星号。而是应该使用空白将注释同代码分开。
在部署发布之前,移除所有临时或无关的注释,避免维护工作中产生混乱。
如果需要用注释来解释复杂的代码节,先检查代码是否应该重写。
在编写注释时使用完整的句子。注释应该阐明代码,而不应该增加多义性。
避免多余的或不适当的注释。
注释代码中不十分明显的任何内容。
为了防止问题反复出现,对错误和解决方法总是使用注释。
对由循环和逻辑分支组成的代码使用注释。
使用具有一致的风格和语言来构造注释。
用空白将注释同注释分隔符分开。
新增代码行的前后要有注释行说明,对具体格式不作要求,但必须包含作者,新增时间,新增目的。在新增代码的最后必须加上结束标志;
善于运用#region,#endregion。
单行注释
用于方法内的代码注释。如变量的声明、代码或代码段的解释。示例:
// 注释语句
private int number;
方法内变量的声明或花括号后的注释,示例: