代码缩进规范.pdfVIP

代码缩进规范

篇一:代码编写规范

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

一、简介

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

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

本规范重要参照了GoogleavaStyle,包括了其他某些业界约定俗成欧I公约

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

1.1术语阐明

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

1.类(class)统指一般类、枚举类、接口和注解类型.

2.注释(comment)只用来指实现注释(implcmcntatio.

comments)o我们不使用“文档注释”这样的说法，而会直接说avadoc。

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

1.2文档阐明

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

1

循本规范，但这不是唯一H勺代码方式。例子中可选H勺格式风格也不应当作为强

制执行H勺规范。

二、源码文献基础

2.1文献名

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

2.2文献编码:UTF-8

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

2.3特殊字符

2.3.1空格字符

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

符。这意味着：

1.其他空白字符将被转义.

2.Tab字符不被用作缩进控制.2.3..特殊转义字符.

任何需要转义字符串表达H勺字符例（如\b,\t,\n,\f,\r,\,

\#39;和\\等），采用这种转义字符串的方式表达，而不采用对应字符日勺八进

制数例（如\012）或Unicode码例（如\u000a）表达。

2.3.3非ASCII字符

对于其他非ASCII字符，直接使用Unicode字符例（如?）,或者对应的

Unicode码例（如\u221e）转义都是容许口勺。唯一需要考虑口勺是，何种方式更能使

代码轻易阅读和理

2

解。

注意:在使用Unicde码转义，或者甚至是有时直接使用Unicde字符日勺时候,

添加一点阐明注释将对他人读懂代码很有协助。三、源码文献构造

源码文献按照先后次序，由如下几部分构成.l.liccns.

或者cpyright中明信息。假（如需要申明）

2.包p（ackage）申明语句.

3.impr.语句.

4.类申明每（个源码文献只能有一种顶级类）.每个部分之间应当只有一行空行

作为间隔.

3.1license或者cpyright的申明信息。

假如需要申明license或cpyright信息，应当在文献开始时申明。

3.2包申明

包申明的行没有行长度日勺限制。单行长度限制不合用于包中明。

3.3imprt语句

3.3.1不使用通配符imprt

即，不要出现类似这样H勺imprt语句：imprtjava.util.*;

3.3.2没有行长度限制

imprt语句的J行没杓行长度的I限制。单行长度限制不合用于imprt语句所在

行。

3

3.3.3次序和空行

imprt语句应当被分为几种组，每个组之间由单行日勺空行隔开。分组日勺次序如

下.1.所有的静态导入为归为一组.

2.cm.sinsft项（目自带包）包日勺imprt归为一组.

3.第三方包。每个顶级包归为一组。第三方包之间按ASCII码排序。例

如：andrid.cm.junit,rg.su.

4.jav.包归为一组.

5.java.包归为一组.同一组内曰勺imprt语句之间不应用空行隔开。同一组中

H勺imprt语句按ASCII码排序.

3.4类申明

风格:

?

?

?

?左大括号前不换行。左大括号后换行。右大括号前换行。假