科瑞尔思项目开发编码规范
一、规范目的
对于代码，首要要求是它必须正确，能够按照程序员的真实思想去运行；第二个要求是
代码必须清晰易懂，使别的程序员能够容易理解代码所进行的实际工作。在软件工程领
域，源程序的风格统一标志着可维护性、可读性，是软件项目的一个重要组成部分。
二、整体编码风格
1. 所有程序都必须包含有清晰、明了的注释。Java 程序使用标准的 Java 代码注释格
式书写。在项目完成时，所有的 Java 代码文档也应该同时完成。
2. 缩进、空格、换行等应该合理使用。
缩进建议以 4 个空格为单位。原则上变量、类、常量数据和函数在其类型，修饰名
称之间适当空格并据情况对齐。关键字原则上空一格，如：if ( ... ) 等。运算符的
空格规定如下："::"、"->"、"["、"]"、"++"、"--"、"~"、"!"、"+"、"-"（指正负号）、
"&"（引用）等几个运算符两边不加空格（其中单目运算符系指与操作数相连的一
边），其它运算符（包括大多数二目运算符和三目运算符"?:"两边均加一空格，在作
函数定义时还可据情况多空或不空格来对齐，但在函数实现时可以不用。","运算
符只在其后空一格，需对齐时也可不空或多空格。
不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。
3. 对齐：
原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。另
每一行的长度不应超过屏幕太多，必要时适当换行，换行时尽可能在","处或运算
符处，换行后最好以运算符打头，并且以下各行均以该语句首行缩进，但该语句仍
以首行的缩进为准，即如其下一行为“{”应与首行对齐。
变量定义最好通过添加空格形成对齐，同一类型的变量最好放在一起。如下例所示：
int Value;
int Result;
int Length;
Object currentEntry;
4. 空行：
不得存在无规则的空行，比如说连续十个空行。程序文件结构各部分之间空两行，
若不必要也可只空一行，各函数实现之间一般空两行，由于每个函数还要有函数说
明注释，故通常只需空一行或不空，但对于没有函数说明的情况至少应再空一行。
对自己写的函数，建议也加上“//------”做分隔。函数内部数据与代码之间应空至
少一行，代码中适当处应以空行空开，建议在代码中出现变量声明时，在其前空一
行。
5. 注释
注释是软件可读性的具体体现。程序注释量一般占程序编码量的 20%，软件工程
要求不少于 20%。程序注释不能用抽象的语言，类似于"处理"、"循环"这样的计算
机抽象语言，要精确表达出程序的处理说明。例如："计算净需求"、"计算第一道
工序的加工工时"等。避免每行程序都使用注释，可以在一段程序的前面加一段注
释，具有明确的处理逻辑。
注释必不可少，但也不应过多，不要被动的为写注释而写注释。以下是四种必要的
注释：
i. 标题、附加说明。
ii. 函数、类等的说明。对几乎每个函数都应有适当的说明，通常加在函数实现之
