? 要使一个Tab为4个空格长。
1.2.缩进? 要使一个代码块内的代码都统一缩进一个Tab长度。
1.3.空行? 建议适当的增加空行,来增加代码的可读性。
? 在在类,接口以及相互之间要有两行空行:
? 不才列情况之间要有一行空行:
要领之间;
局部变量和它后边的语句之间;
要领内的成果逻辑部分之间;
1.4.函数长度每个函数有效代码(不包孕注释和空行)长度不要赶过100行,尽可能控制在50行。
1.5.{”,“}”? 开括号“{”要放在块的所有者的下一行,单起一行;
? 闭括号“}”要单独放在代码块的最后一行,单起一行。
1.6.行宽每行代码和注释不要赶过70个字符或屏幕的宽度,如赶过则应换行,换行后的代码应该缩进一个Tab。
1.7. 空格′ 括号和它里面的字符之间不要呈现空格。括号应该和它前边的关键词留有空格,如:while (true) {};
′ 但是要领名和左括号之间不要有空格。
? 参数之间的逗号后要加一空格。如:method1(int i1, int i2)
? for语句里的表达式之间要加一空格。如:for (expr1; expr2; expr3)
? 二元操纵符和操纵数之间要用空格离隔。如:i + c;
? 强制类型转换时,在类型和变量之间要加一空格。如:(int) i ;
2. 注释 2.1.注释的根基约定? 注释应该增加代码的清晰度;
? 连结注释的简洁,不是任何代码都需要注释的,过多的注释反而会影响代码的可读性。
′ 注释不要包孕其他的特殊字符。
? 建议先写注释,后写代码,注释和代码一起完成
? 如果语句块(好比循环和条件分枝的代码块)代码太长,嵌套太多,则在其结束“}”要加上注释,标识表记标帜对应的开始语句。如果分支条件逻辑对照庞大,也要加上注释。
? 在VS2005环境中通过配置工程编译时输出XML文档文件可以查抄注释的完整情况,如果注释不完整会呈报编译警告;
2.2.注释类型 2.2.1.块注释? 主要用来描述文件,类,要领,算法等,放在所描述东西的前边。具体格局以IDE编纂器输入“///”自动生成的格局为准,此外再附加我们自界说的格局,如下所列:
/// <Remark>作者,创建日期,改削日期</ Remark >
对类和接口的注释必需加上上述符号,对要领可以视情况考虑
2.2.2.行注释? 主要用在要领内部,对代码,变量,流程等进行说明。整个注释占据一行。
2.2.3.尾随注释? 与行注释成果相似,放在代码的同行,但是要与代码之间有足够的空间,便于分清。例:
int m = 4 ; // 注释
? 如果一个措施块内有多个尾随注释,每个注释的缩进要连结一致。
2.3.注释哪些部分项目
注释哪些部分
参数
参数用来做什么
任何约束或前提条件
字段/属性
字段描述
类
类的目的
已知的问题
类的开发/维护历史
接口
目的
它应如何被使用以及如何不被使用
局部变量
用处/目的
成员函数注释
成员函数做什么以及它为什么做这个
哪些参数必需通报给一个成员函数
成员函数返回什么
已知的问题
任何由某个成员函数抛出的异常
成员函数是如何转变东西的
包罗任何改削代码的历史
如安在适当情况下挪用成员函数的例子适用的前提条件和后置条件
成员函数内部注释
控制布局
代码做了些什么以及为什么这样做
局部变量
难或庞大的代码
措置惩罚惩罚挨次
事件成员
事件用途
事件可能引发的异常
事件的参数含义
? 不是所有的成员函数都必需要注释,以下成果函数可以不加注释:
界面模块的成果按钮事件函数
override的函数
private的函数可以选择性的插手注释,如果private函数的成果十分简单,可以不插手注释,否则建议插手注释
? private的字段/属性可以不加注释
? 局部变量只需要用”//”说明即可
2.4.措施改削注释