Java相.docVIP

Java编码规范 1. 说明 1.1 为什么要有编码规范 编码规范对于程序员而言尤为重要，有以下几个原因： ◆ 一个软件的生命周期中，80%的花费在于维护。 ◆ 几乎没有任何一个软件，在其整个生命同期中，均由最初的开发人员来维护。 ◆ 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新代码。 ◆ 如果你将源码作为产品发布，就需要确认它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品。 为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人!!! 1.2 版权声明 本文档反映的是Sun Microsystem公司，Java语言规范中的编码标准部分。主要贡献者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。本文档现由Scott Hommel维护，有关评论请发至shommel@。 2. 文件名(File Names) 这部分列出了常用的文件名及其后缀。 2.1 文件后缀(File Suffixes) Java程序使用下列文件后缀： 文件类别 文件后缀 Java源文件 .java Java字节码文件 .class 2.2 常用文件名(Common File Names) 常用的文件名包括： 文件名 用途 GNUmakefile makefiles的首选文件名。我们采用gnumake来创建(build)软件。 README 概述特定目录下所含内容的文件的首选文件名。 3. 文件组织(File Orgnization) 一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。“Java源文件范例”提供了一个页面布局合理的Java程序范例。 3.1 Java源文件(Java Source Files) 每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联。可以将它们和公共类放入同个源文件。公共类必须是这个文件中的第一个类和接口。 Java源文件还遵循以下规则： ◆ 开头注释(参见“开头注释”) ◆ 包和引入语句(参见“包和引入语句) ◆ 类和接口声明(参见“类和接口声明) 3.1.1 开头注释(Beginning Comments) 所有的源文件都应该在开头有一个C语言风格的注释，其中列出数出类名、版本信息，日期和版权声明： / * * Classname * * Version information * * Date * * Copyright notice * / 3.1.2 包和引入(Package and Import Statements) 在多数Java源文件中，第一个非注释行是包语句行。在它之后可以跟引入语句。例如： package java.awt; import java.awt.peer.CanvasPeer; 3.1.3 类和接口声明(Class and Interface Declarations) 下表描述了类和接口声明的免修部分以及它们出现的先后次序。参见“Java源文件范例”中一个包含注释的例子。 类/接口声明的各部分 注解 1 类/接口文档注释 (/ **…* /) 该注释中所包含的信息，参见“文档注释” 2 类/接口的声明 3 类/接口实现的注释 (/ *…* /) 如果有必要的话 该注释应包含任何有关整个类或接口的信息，而这些信息又适合作为类/接口文档注释。 4 类的(静态)变量 首先是类的public变量，随后是protected变量，再后是包一级别的变量(没有访问修饰符)，最后是private变量。 5 实例变量 首先是public变量，随后是protected变量，再后是包一级别的变量(没有访问修饰符)，最后是private变量。 6 构造器 7 方法 这些方法应该按功能，而非作用域或访问权限，分组。 4. 缩进排版(Indentation) 4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格vs.制表符)。一个制表符等于8个空格(而非4个)。 4.1 行长度 尽量避免一行长度超过80个字符，因为很多终端和工具不能很好处理之。注意：用于文档是的例子应该使用更短的行长，长度一般不超过70个字符。 4.2 换行(Wrapping Lines) 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之： ◆ 在一个逗号后面断开。 ◆ 在一个操作符前面断开。 ◆ 宁可选择较高级别的(higher-level)的断开，而非较低级别(lower-level)的断开。 ◆ 新的一行应该与上一行同一级别表达式