C 开发规范.doc

C_开发规范易泓管理咨询开发参考文档文档准备人:张炜制作日期: 2010年01月08日提交日期: 2010年01月08日版本号: :易泓管理咨询浙江省杭州市滨江区江陵路1760号邮编:310051®易泓公司&Geely版权所有本文档特为上海易泓企业管理咨询有限公司软件开发制作CreatingCustomerValues为客户创造价值文档描述文件名状态C#开发规范未评审变更记录日期 作者版本描述2010-01-. 简介 . 目的 . 范围 . 引用、参考 52. 代码组织与风格 . TAB . 空行 . 代码块长度 . “{”,“}” . 行宽 . 空格 63. 注释 . 注释的基本约定 ,不是任何代码都需要注释的,过多的注释反而会影响代码的可读性 ,后写代码 . 注释类型 . 注释那些部分 74. 命名 . 命名的基本约定 . 标示符的命名约定 95. 声明 106. 表达式和语句 117. 错误处理和异常事件 128. 可移植性 12简介目的本规范为一套编写高效可靠的C#代码的标准、约定和指南。它以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强,提高生产效率。同时,将带来更大的一致性,使软件开发团队的效率明显提高。范围本规范应用于采用C#规范的项目中,所有项目中的C#代码(含ASPX)均应遵守这个规范。同时,也可作为其它项目的参考。引用、参考参考了《JAVA开发规范》代码组织与风格TAB一个Tab为4个空格长。空行适当的增加空行,来增加代码的可读性。在下列情况下应该有两行空行:同一文件的不同部分之间;在类,接口以及彼此之间;在下列情况之间应该有一行空行:方法之间;局部变量和它后边的语句之间;方法内的功能逻辑部分之间;代码块长度每个代码块尽量控制在1个屏幕之内,方便浏览。“{”,“}”开括号“{”放在块的所有者所在行的最后面,闭括号“}”单独放在代码块的最后一行。行宽每行代码和注释不应超过70个字节或屏幕的宽度,如超过则应换行,换行后的代码应该缩进8个字符。空格括号和它里面的字符之间不应该出现空格。括号应该和它前边的关键词留有空格,如:while(true){};但是方法名和左括号之间不应该有空格。参数之间的逗号后应该加一空格。如:method1(inti1,inti2)for语句里的表达式之间加一空格。如:for(expr1;expr2;expr3)二元操作符和操作数之间应该用空格隔开。如:i+c;强制类型转换时,在类型和变量之间加一空格。如:(int)i;,不是任何代码都需要注释的,,:主要用来描述文件,类,方法,算法等。一般用在文档和方法的前面,也可以放在文档的任何地方。以‘/*’开头,‘*/’结尾。例:……/** 注释*/……:主要用在方法内部,对代码,变量,流程等进行说明。与块注释格式相似,但是整个注释占据一行。例:……/* 注释 */……:与行注释功能相似,放在代码的同行,但是要与代码之间有足够的空间,便于分清。例:intm=4; /* 注释 */如果一个程序块内有多个尾随注释,每个注释的缩进应该保持一致。:与行注释功能相似,放在每行的最后,或者占据一行。以‘//’开头或以‘///’开头。:与块注释相似,但是可以被javadoc处理,生成HTML文件。以‘/**’开头,‘*/’结尾。问挡住是不能放在方法或程序块内。例:/** 注释*/注释那些部分项目注释哪些部分实参/参数参数类型参数用来做什么任何约束或前提条件示例字段/字段/属性字段描述注释所有使用的不变量示例并行事件可见性决策类类的目的已知的问题类的开发/维护历史注释出采用的不变量并行策略编译单元每一个类/类内定义的接口,含简单的说明文件名和/或标识信息版权信息接口目的它应如何被使用以及如何不被使用局部变量用处/目的成员函数注释成员函数做什么以及它为什么做这个哪些参数必须传递给一个成员函数成员函数返回什么已知的问题任何由某个