代码编写规范

《代码编写规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、.-知识管理系统代码编写规一、介绍本文档为?知识管理系统?代码编写规，为保证代码风格的一致性和后期的可维护性，文档讲述的容要求所有开发人员必须遵守。本规主要参考了GoogleJavaStyle，包括了其他一些业界约定俗成的公约和普遍采用的标准。本规并非最终标准，一些规定还需再做商讨。1.1术语说明本文档除非特殊说明，否那么：1.类〔class〕统指普通类、枚举类、接口和注解类型。2.注释〔comment〕只用来指实现注释〔implementationcomments〕。我们不使用“文档注释〞这样的说法，而会直接说Javadoc。其他“术语说

2、明〞，将在文档中需要说明的地方单独说明。1.2文档说明本文档中的代码并不一定符合所有规。即使这些代码遵循本规，但这不是唯一的代码方式。例子中可选的格式风格也不应该作为强制执行的规。.可修编..-二、源码文件根底2.1文件名源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java。2.2文件编码：UTF-8源码文件使用UTF-8编码。2.3特殊字符2.3.1空格字符除了换行符外，ASCII水平空白字符〔0x20〕是源码文件中唯一支持的空格字符。这意味着：1.其他空白字符将被转义。2.Tab字符不被用作缩进控制。2.3.2特殊转义字符串

3、任何需要转义字符串表示的字符〔例如b, t, , f, r, ", '和\等〕，采用这种转义字符串的方式表示，而不采用对应字符的八进制数〔例如 12〕或Unicode码〔例如 u000a〕表示。2.3.3非ASCII字符对于其余非ASCII字符，直接使用Unicode字符〔例如 ∞〕，或者对应的Unicode码〔例如 u221e〕转义都是允许的。唯一需要考虑的是，何种方式更能使代码容易阅读和理解。.可修编..-注意：在使用Unicode码转义，或者甚至是有时直接使用Unicode字符的时候，添加一点说明注释将对别人

4、读懂代码很有帮助。三、源码文件构造源码文件按照先后顺序，由以下几局部组成：1.license或者copyright声明信息。〔如果需要声明〕2.包〔package〕声明语句。3.import语句。4.类声明〔每个源码文件只能有一个顶级类〕。每个局部之间应该只有一行空行作为间隔。3.1license或者copyright的声明信息。如果需要声明license或copyright信息，应该在文件开场时声明。3.2包声明包声明的行没有行长度的限制。单行长度限制不适用于包声明。3.3import语句3.3.1不使用通配符import即，不要出现类似

5、这样的import语句：importjava.util.*;3.3.2没有行长度限制import语句的行没有行长度的限制。单行长度限制不适用于import语句所在行。.可修编..-3.3.3顺序和空行import语句应该被分为几个组，每个组之间由单行的空行隔开。分组的顺序如下：1.所有的静态导入为归为一组。2..sinosoft〔工程自带包〕包的import归为一组。3.第三方包。每个顶级包归为一组。第三方包之间按ASCII码排序。例如：android, , junit,org, sun4.java 包归为一组。5.javax 包归为一组。

6、同一组的import语句之间不应用空行隔开。同一组中的import语句按ASCII码排序。3.4类声明3.4.1只声明一个顶级类每个源码文件中只能有一个顶级类。例外：package-info.java，该文件中可没有package-info类。3.4.2类成员顺序类成员的顺序对代码的易读性有很大影响，但这也不存在唯一的通用法那么。不同的类可能有不同的排序方式。重要的是，每个类都要按照一定的逻辑规律排序。维护者应该要能解释这种排序逻辑。比方，新的方法不能总是习惯性地添加到类的结尾，因为这样就是按时间顺序而非某种逻辑来排序的。3.4.2.1重载

7、方法：不应该分开.可修编..-当一个类有多个构造函数，或者多个同名成员方法时，这些函数应该写在一起，不应该被其他成员分开。四、格式术语说明：块状构造〔block-likeconstruct〕指类、成员函数和构造函数的实现局部〔大括号中间局部〕。注意，在后面的4.8.3.1节中讲到数组初始化，所有的数组初始化都可以被认为是一个块状构造〔非强制〕。4.1大括号4.1.1大括号不可省略大括号一般用在if, else, for, do和while等语句。即使当它的实现为空或者只有一句话时，也需要使用。4.1.2非空语句块采用K&R风格对于非空语句块

8、，大括号遵循Kernighan&Ritchie风格：·左大括号前不换行。·左大括号后换行。·右大括号前换行。·如果右大括号完毕一个语句块或者函数体、构造函数体或者有命名的类体，那