代码编写规范课件.docVIP

知识管理系统代码编写规范 一、介绍 本文档为 《知识管理系统》 代码编写规范， 为保证代码风格的一致性和后期的可 维护性，文档讲述的内容要求所有开发人员必须遵守。 本规范主要参考了 Google Java Style ，包括了其他一些业界约定俗成的公约和 普遍采用的标准。本规范并非最终标准，一些规定还需再做商讨。 1.1 术语说明 本文档除非特殊说明，否则： 1. 类（class ）统指普通类、枚举类、接口和注解类型。 2. 注释（ comment ）只用来指实现注释（ implementation comments ）。我们不使用 “文档 注释 ”这样的说法，而会直接说 Javadoc 。 其他“术语说明 ”，将在文档中需要说明的地方单独说明。 1.2 文档说明 本文档中的代码并不一定符合所有规范。 即使这些代码遵循本规范， 但这不是唯 一的代码方式。例子中可选的格式风格也不应该作为强制执行的规范。 二、源码文件基础 2.1 文件名 源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为 .java 。 2.2 文件编码： UTF-8 源码文件使用 UTF-8 编码。 2.3 特殊字符 2.3.1 空格字符 除了换行符外， ASCII 水平空白字符（ 0x20 ） 是源码文件中唯一支持的空格字 符。这意味着： 1. 其他空白字符将被转义。 2. Tab 字符不被用作缩进控制。 2