java代规范.docVIP

Java语言代码规范 2 – 文件命名 本节是列出了文件扩展名和文件命名的一般性习惯。 2.1 文件扩展名 JAVA软件使用以下文件扩展名: 文件类型 扩展名 Java源程序 .java Java字节码 .class 2.2 文件命名 经常使用的文件名称有: 文件名 用途 GNUmakefile Makefiles首选名称. 我们使用gnumake来构建软件. README Readme文件首选名称。 3 – 文件组织 组成文件的段落应当用空行分开，并且可以使用注释将每个段落标识出来。 超过2000行的文件会显示臃肿，因此应当尽量避免。 适当的JAVA文件格式，请参见 HYPERLINK /docs/codeconv/html/CodeConventions.doc10.html \l 182 JAVA代码示例. 3.1 JAVA源文件 每一个Java源文件包含一个公共的类或者接口。当私有的类和接口与这个公共的类和接口关联时，您可以将它们放到相同的文件中。公共类和接口应当是文件中的第一个类或者接口。 Java源文件存在以下顺序: 文件开始处的注释 (参见 HYPERLINK /docs/codeconv/html/CodeConventions.doc2.html \l 3441 开始注释) 包和导入定义 类和接口定义 (参见 HYPERLINK /docs/codeconv/html/CodeConventions.doc2.html \l 1852 类和接口定义) 3.1.1 开始注释 所有的源文件都应该以一个C风格的注释开始，注释中应当列出类名，版本信息，日期和版权声明: /* * 类名 * * 版本信息 * * 日期 * * 版权声明 */ 3.1.2 包和导入声明 绝大多数JAVA源文件的第一个非注释行是package语句。之后, import 语句出现。如: package java.awt; import java.awt.peer.CanvasPeer; 提示: 唯一包名的第一部分总是以全,,,,写ASCII 字符书写，并且应当是顶级域名，通常是com, edu, gov, mil, net, org或者两位由英文字母标识的国家代码。国家代码由ISO Standard 3166, 1981规范指定（译者注：如中国的国家代码为cn）。 3.1.3 类和接口定义 下表描述了接口和类定义，定义的样式请参见 HYPERLINK /docs/codeconv/html/CodeConventions.doc10.html \l 182 Java代码示例. 类和接口定义 备注 1 类/接口文档注释 (/**...*/) 参见 HYPERLINK /docs/codeconv/html/CodeConventions.doc4.html \l 16838 文档注释. 2 Class或者interface 声明 3 如果有必要，对类/接口编写实现注释 (/*...*/) 该注释应当包含任何接口/类信息，这些信息不适合在类/接口文档注释中出现。 4 类 (静态)变量 首先是公共类变量，其次是保护变量，其次是包级别变量 (无访问修饰符), 最后是私有变量. 5 实例变量 首先是公共实例变量，其次是保护变量，其次是包级别变量 (无访问修饰符), 最后是私有变量. 6 构造器 7 方法 以功能对这些方法分组比以作用域或者可访问性分组更适当. 例如, 一个私有的类方法可以在公共的实例方法之间. 其目的是使阅读和理解代码更容易. 4 – 缩排 缩排应当以四个空格为单位. 没有强制的缩排规定 (空格vs. tabs)（译者注：这是java语言规范中定义的，在大多数的项目中，均规定以四个空格为缩排单位而不是tabs）。Tabs必须被设置为八个空格 (而不是四个). 4.1 行宽 避免每行超过80字符,因为超过部分不会被许多终端或者工具处理。 注意: 文档中使用的例子应当更短，一般不要超过70个字符. 4.2 折行 当一个表达式不能在一行中书写完毕时，通过以下方式折行: 在“，”后面折行. 在一个操作符前折行. 以代码层次高低决定折行，层次高的代码在同一行. 同一层次的代码左边对齐. 如果上一规则使代码变得不清晰，则统一都缩排8个空格. 以下是一些方法调用折行的示例: someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longEx