信息技术中心网站技术部
知识管理系统代码编写规范
一、介绍
本文档为《知识管理系统》代码编写规范，为保证代码风格的一致性和后期的可维护性，文档讲述的内容要求所有开发人员必须遵守。
本规范主要参考了Google Java Style，包括了其他一些业界约定俗成的公约和普遍采用的标准。本规范并非最终标准，一些规定还需再做商讨。
1.1 术语说明
本文档除非特殊说明，否则：
1. 2.
类（class）统指普通类、枚举类、接口和注解类型。
注释（comment）只用来指实现注释（implementation comments）。我们不使用“文档注释”这样的说法，而会直接说Javadoc。
其他“术语说明”，将在文档中需要说明的地方单独说明。
1.2 文档说明
本文档中的代码并不一定符合所有规范。即使这些代码遵循本规范，但这不是唯一的代码方式。例子中可选的格式风格也不应该作为强制执行的规范。
页脚内容21
信息技术中心网站技术部 二、源码文件基础
2.1 文件名
源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java。
2.2 文件编码：UTF-8
源码文件使用UTF-8编码。
2.3 特殊字符
2.3.1 空格字符
除了换行符外，ASCII 水平空白字符（0x20）是源码文件中唯一支持的空格字符。这意味着：
1. 2.
其他空白字符将被转义。 Tab字符不被用作缩进控制。
2.3.2 特殊转义字符串
任何需要转义字符串表示的字符（例如\\b, \\t, \\n, \\f, \\r, \\\, \\'和\\\\等），采用这种转义字符串的方式表示，而不采用对应字符的八进制数（例如 \\012）或 Unicode 码（例如 \ ）表示。
2.3.3 非 ASCII 字符
对于其余非ASCII字符，直接使用Unicode字符（例如 ∞），或者对应的Unicode码（例如 \∞）转义都是允许的。唯一需要考虑的是，何种方式更能使代码容易阅读和理解。
页脚内容21
信息技术中心网站技术部 注意：在使用Unicode码转义，或者甚至是有时直接使用Unicode字符的时候，添加一点说明注释将对别人读懂代码很有帮助。
三、源码文件结构
源码文件按照先后顺序，由以下几部分组成：
1. 2. 3. 4.
license 或者 copyright 声明信息。（如果需要声明） 包（package）声明语句。 import 语句。
类声明（每个源码文件只能有一个顶级类）。
每个部分之间应该只有一行空行作为间隔。
3.1 license 或者 copyright 的声明信息。
如果需要声明 license 或 copyright 信息，应该在文件开始时声明。
3.2 包声明
包声明的行没有行长度的限制。单行长度限制不适用于包声明。
3.3 import语句
3.3.1 不使用通配符import
即，不要出现类似这样的import语句：import java.util.*;
3.3.2 没有行长度限制
import 语句的行没有行长度的限制。单行长度限制不适用于import 语句所在行。
页脚内容21
代码编写规范
