JAVA编程语言编码规范.doc

JAVA 编程语言的代码惯例 1、介绍 为什么要有代码惯例代码惯例之所以重要有以下几点原因: 软件寿命价值的 80% 是维护。几乎没有软件在整个使用过程中都有由原作者维护。代码惯例增加了软件包的可读性,使工程师们能更快、更完整地理解新软件。如果你想把你的原始代码变成产品, 你需要确认它是否和你生产的其它产品一样有好的包装。 确认这个文件在 SUN 公司的 JAVA 语言说明书中反映了 JAVA 语言编码标准。这方面规定主要来自 P eter King,Patrick Naughton,Jonni Kanerva,and Scott Hommel. 关于这个文档的改写、修改或再分配的问题,请看版权公告。对于这个文档的建议请发贴自 ******@eng. 2------ 文件名这一节列举了常用的文件后缀与名称。 文件后缀 JAVA 使用以下后缀: 文件种类后缀 JAVA source .java JAVA bytecode .class 普通文档名称通常用的文档名称文档名称使用 GNUmakefile makefile 最恰当的名字。我们使用 gnumak e 制造我们的软件。 Readme 概括特定目录内容的文档的最恰当名称。 3. 文件的组织结构一个文件应当由多个被分隔的段组成,并由空行和可选择注释来识别。超过 2000 行的文件由于冗长而应当避免。 Java 程序的正确格式可参看第 19 页的范例“ Java 源文件范例”。 Java 源文件每一个 Java 源文件包含一个单一的公共类或界面。当私有类或界面与一个公共类发生联系时, 你可以将它们以一个公共类放入同一个源文件。公共类应当是文件中的第一类或界面。 Java 源文件有如下次序: 起始注释(参看第 4页“起始注释”) 组件和导入语句类和界面声明(参看第 4页“类和界面声明”) 起始注释所有源文件应当以 C 格式注释开始,并列出类名,版本信息,时间和版权说明: /* * 类名** 版本信息** 时间** 版权说明*/ 组件和导入语句对于大部分 Java 源文件而言, 第一个无注释行是组件语句。之后, 紧跟着是导入语句。举例如下: 组件 ; 导入 注释: 对于唯一的组件名, 第一部分总是小写的 ASCII 码格式的文本文件, 并且是最高级别的域名之一。,edu,gov, 或 ISO3166 标准( 1981 ) 中规定的用于识别国家的英文两个字母的模式。 类和界面声明下表按出现的先后顺序描述了一个类或界面说明的各部分。参见第 19页“ java 源文件范例”中一个包含注释的示例。类/ 界面声明的各部分注释 1类/ 界面文档注释(/ **…*/) 参看第 9页“文挡注释”中注释的具体内容 2 类或界面语句 3类/ 界面补充注释( /*…*/), 如果必要的话这一注释应包含任一类宽或界面宽度的信息, 它不适合于类/ 界面文档注释。 4 类(静态的)变量首先是公共类变量, 其次是保护类, 然后是组件级(无访问修改权) ,最后是私有类。 5 实例变量首先是公共类, 其次是保护类, 然后是组建级( 无访问修改权) ,最后是私有类。 6 构成 7 过程这些过程应当以功能而非作用域和可访问性来分组。举例说明,一个私有类变量过程可在两个公共实例过程中。其目的是使读和理解代码更为容易。 4、缩进格式四个空格作为一个缩进单位。确切的缩进格式结构( 空格符与制表符) 未被规范。表格的设置必须在每 8 个空格后(而非 4个)。 行的长度由于难于被大多数终端和工具进行处理,应当避免一行超过 80 个字符。注释:在文档中所列举的范例其行的长度应稍短些,一般不超过 70 个字符。 绕回行当表达式一行无法写完时,使用以下一般规则进行中断: 在逗号后中断。在一个运算符前中断。优先选择高级中断指令。新行起始表达式的位置应与旧行表达式的位置对齐。如果上述规则导致代码混乱或编码时顶到了右边界,以 8 个空格代替。以下是几个中断程序的调用范例: someMethod(long Expression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3); 以下是两个关于中断算术表达式的例子。第一个例子由于中断发生在插入表达式以外, 因而选择了高级中断指令。 longName1 = longName2 * (longN