优化你的代码风格规范.pdfVIP

知识管理系统代码编写规范

一、简介

本文档为《知识管理系统》代码编写规范，为保证代码风格日勺一致性和期日勺

可维护性，文档讲述的内容规定所有开发人员必须遵守。

本规范重要参照了GoogleJavaStyle,包括了其他某些业界约定俗成的公约和

普遍采用的原则。本规范并非最终原则，某些规定还需再做商讨。

1.1术语阐明

本文档除非特殊阐明，否则：

1.类c（lass）统指一般类、枚举类、接口和注解类型。

2.注释c（omment）只用来指实现注释i（mplementationcomments）o我们不使用文档

注释”这样H勺说法，而会直接说Javadoc。

其他术“语阐明”，将在文档中需要阐明的地方单独阐明。

1.2文档阐明

本文档中的代码并不一定符合所有规范。虽然这些代码遵照本规范，但这不是

唯一的代码方式。例子中可选的格式风格也不应当作为强制执行的规范。

二、源码文献基础

2.1文献名

源文献以其最顶层的类名来命名，大小写敏感，文献扩展名为.java。

2.2文献编码:UTF-8

源码文献使用UTF-8编码。

2.3特殊字符

2.3.1空格字符

除了换行符外，ASCII水平空白字符（0x20）是源码文献中唯一