【最新整理,下载后即可编辑】
C#开发规范
版本 V1.0
更新时间 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;} 程序注释 注释原则
【最新整理,下载后即可编辑】