C 开发规范.doc

C_开发规范.doc.docC#开发规范
易泓管理咨询开发参考文档
文档准备人: 张炜
制作日期: 2010年01月08日
提交日期: 2010年01月08日
版本号:
状态:
易泓管理咨询
浙江省杭州市滨江区江陵路1760号
邮编:310051
®易泓公司& Geely 版权所有
本文档特为上海易泓企业管理咨询有限公司软件开发制作
Creating Customer Values
为客户创造价值
文档描述
文件名
状态
C#开发规范
未评审
变更记录
日期
作者
版本
描述
2010-01-08
张炜

审阅
审阅者
审阅时间
注释
目录
1. 简介 5
. 目的 5
. 范围 5
. 引用、参考 5
2. 代码组织与风格 5
. TAB 5
. 空行 5
. 代码块长度 6
. “{”,“}” 6
. 行宽 6
. 空格 6
3. 注释 6
. 注释的基本约定 6
注释的基本约定 6
注释应该增加代码的清晰度 6
保持注释的简洁,不是任何代码都需要注释的,过多的注释反而会影响代码的可读性 6
注释不应该包括其他的特殊字符 6
先写注释,后写代码 6
. 注释类型 7
块注释 7
行注释 7
尾随注释 7
行尾注释 7
文档注释 7
. 注释那些部分 7
4. 命名 9
. 命名的基本约定 9
. 标示符的命名约定 9
5. 声明 10
6. 表达式和语句 11
7. 错误处理和异常事件 12
8. 可移植性 12
简介
目的
本规范为一套编写高效可靠的C# 代码的标准、约定和指南。它以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强,提高生产效率。同时,将带来更大的一致性,使软件开发团队的效率明显提高。
范围
本规范应用于采用C#规范的项目中,所有项目中的C#代码(含ASPX)均应遵守这个规范。同时,也可作为其它项目的参考。
引用、参考
参考了《JAVA开发规范》
代码组织与风格
TAB
一个Tab为4个空格长。
空行
适当的增加空行,来增加代码的可读性。
在下列情况下应该有两行空行:
同一文件的不同部分之间;
在类,接口以及彼此之间;
在下列情况之间应该有一行空行:
方法之间;
局部变量和它后边的语句之间;
方法内的功能逻辑部分之间;
代码块长度
每个代码块尽量控制在1个屏幕之内,方便浏览。
“{”,“}”
开括号“{”放在块的所有者所在行的最后面,闭括号“}”单独放在代码块的最后一行。
行宽
每行代码和注释不应超过70个字节或屏幕的宽度,如超过则应换行,换行后的代码应该缩进8个字符。
空格
括号和它里面的字符之间不应该出现空格。括号应该和它前边的关键词留有空格,如:while (true) {};
但是方法名和左括号之间不应该有空格。
参数之间的逗号后应该加一空格。如:method1(int i1, int i2)
for语句里的表达式之间加一空格。如:for(expr1; expr2; expr3)
二元操作符和操作数之间应该用空格隔开。如:i + c ;
强制类型转换时,在类型和变量之间加一空格。如:(int) i ;
注释
注释的基本约定
注释的基本约定
注释应该增加代码的清晰度
保持注释的简洁,不是任何代码都需要注释的,过多的注释反而会影响代码的可读性
注释不应该包括其他的特殊字符
先写注释,后写代码
注释类型
块注释
块注释:主要用来描述文件,类,方法,算法等。一般用在文档和方法的前面,也可以放在文档的任何地方。以‘/*’开头,‘*/’结尾。例:
……
/*
* 注释
*/
……
行注释
行注释:主要用在方法内部,对代码,变量,流程等进行说明。与块注释格式相似,但是整个注释占据一行。例:
……
/* 注释 */
……
尾随注释
尾随注释:与行注释功能相似,放在代码的同行,但是要与代码之间有足够的空间,便于分清。例:
int m=4 ; /* 注释 */
如果一个程序块内有多个尾随注释,每个注释的缩进应该保持一致。
行尾注释
行尾注释:与行注释功能相似,放在每行的最后,或者占据一行。以‘//’开头或以‘///’开头。
文档注释
文档注释:与块注释相似