编程规范.docx

.{”,“}”:;::::,ArgumentNullException,,IndexOutOfRangeException,::: #代码的标准、约定和指南。它以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强,提高生产效率。同时,将带来更大的一致性,使软件开发团队的效率明显提高。#源代码,为详细设计,代码编写和代码审核提供参考和依据。:要,建议,避免,不要,表示需要遵循的级别。文档中会以粗体表示。对于应遵循的规范,前面会以“Ö”来表示,对不好的做法前面会以“´”来表示:要:描述必须遵循的规范。例如:Ö异常类要以“Exception”做为后缀;建议:描述在一般情况下应该遵循的规范,但如果完全理解规范背后的道理,并有很好的理由不遵循它时,也不畏惧打破常规。例如:Ö强制类型转换时,在类型和变量之间建议加一空格。不要:描述一些几乎绝对绝不应该违反的规范。例如:´每个函数有效代码(不包括注释和空行)长度不要超过50行。避免:与建议相对,一般情况下应该遵循,但有很好的理由时也可以打破。例如:´ 避免块内部的变量与它外部的变量名相同。对一些规范内容一并提供了示例代码。Ö 要使一个Tab为4个空格长。Ö 要使一个代码块内的代码都统一缩进一个Tab长度。Ö 建议适当的增加空行,来增加代码的可读性。Ö在在类,接口以及彼此之间要有两行空行:Ö在下列情况之间要有一行空行:方法之间;局部变量和它后边的语句之间;方法内的功能逻辑部分之间;´每个函数有效代码(不包括注释和空行)长度不要超过50行。.{”,“}”Ö开括号“{”要放在块的所有者的下一行,单起一行;Ö闭括号“}”要单独放在代码块的最后一行,单起一行。´每行代码和注释不要超过70个字符或屏幕的宽度,如超过则应换行,换行后的代码应该缩进一个Tab。´括号和它里面的字符之间不要出现空格。括号应该和它前边的关键词留有空格,如:while(true){};´但是方法名和左括号之间不要有空格。Ö参数之间的逗号后要加一空格。如:method1(inti1,inti2)Öfor语句里的表达式之间要加一空格。如:for(expr1;expr2;expr3)Ö二元操作符和操作数之间要用空格隔开。如:i+c;Ö强制类型转换时,在类型和变量之间要加一空格。如:(int)i;Ö注释应该增加代码的清晰度;Ö保持注释的简洁,不是任何代码都需要注释的,过多的注释反而会影响代码