2024年6月12日发(作者：)
Java编码规
Java编码规1
1.说明2
1.1 为什么要有编码规2
1.2 声明2
2. 文件名(File Names)2
2.1 文件后缀(File Suffixes)2
3.1 Java源文件(Java Source Files)2
开头注释(Beginning Comments)2
包和引入(Package and Import Statements)2
类和接口声明(Class and Interface Declarations)2
4.1 行长度3
4.2 换行(Wrapping Lines)3
// CONVENTION INDENTATION3
Object andStillAnother) {3
|| !(condition5 && condition6)) {3
5. 注释(Comments)4
5.1 实现注释的格式(Implementation Comment Formats)4
块注释4
单行注释(Single-Line Comments)4
尾端注释(Trailing Comments)4
行末注释(End-Of-Line Comments)4
5.2 文档注释(Documentation Comments)4
6. 声明(Declaration)5
6.1 每行声明变量的数量(Number Per Line)5
6.2 初始化(Initialization)5
6.3 布局(Placement)5
7.1 简单语句(Single Statement)5
7.2 复合语句(Compound Statements)5
7.3 返回语句(return Statements)s6
7.4 if, if-else, if else-if else语句(if, if-else, if else-if else Statements)6
} else {6
} else if (condition) {6
} else if (condition) {6
7.5 for语句(for Statements)6
7.6 while语句(while Statements)6
7.7 do-while语句(do-while Statements)6
7.8 switch语句(switch Statements)6
7.9 try-catch语句(try-catch Statements)6
} catch (ExceptionClass e) {6
} catch (ExceptionClass e) {6
} finally {6
8. 空白(White Space)6
8.1 空行(Blank Lines)6
8.2 空格(Blank Spaces)7
1 / 10
9. 命名规(Naming Convention)7
10. 编程惯例(Programming Practices)7
10.1 提供对实例以与类变量的访问控制(Providing Access to Instance and Class Variables)7
10.2 引用类变量和类方法(Referring to Class Variables and Methods)8
10.4 变量赋值(Variable Assignments)8
10.5 其它惯例(Miscellaneous Practices)8
圆括号(Parentheses)8
返回值(Returning Values)8
条件运算符“?〞前的表达式(Expressions before “?〞 in the Conditional Operator)8
特殊注释(Special Comments)8
11. 代码例(Code Examples)8
11.1 Java源文件例(Java Source File Example)8
1.说明
1.1 为什么要有编码规
编码规对于程序员而言尤为重要，有以下几个原因：
◆一个软件的生命周期中，80%的花费在于维护。
◆几乎没有任何一个软件，在其整个生命同期中，均由最初的
开发人员来维护。
◆编码规可以改善软件的可读性，可以让程序员尽快而彻底地
理解新代码。
◆如果你将源码作为产品发布，就需要确认它是否被很好的打
包并且清晰无误，一如你已构建的其它任何产品。
为了执行规，每个软件开发人员必须一致遵守编码规。每个
人!!!
1.2 声明
本文档反映的是Sun Microsystem公司，Java语言规中的编
码标准局部。主要奉献者包括：Peter King，Patrick Naughton，
Mike DeMoney，Jonni Kanerva，Kathy Walrath以与Scott Hommel。
本文档现由Scott Hommel维护，有关评论请发至.。
2. 文件名(File Names)
这局部列出了常用的文件名与其后缀。
2.1 文件后缀(File Suffixes)
Java程序使用以下文件后缀：
文件类别
Java源文件
Java字节码文件
文件后缀
.java
.class
一个文件由被空行分割而成的段落以与标识每个段落的可选
注释共同组成。超过2000行的程序难以阅读，应该尽量防止。“Java
源文件例〞提供了一个页面布局合理的Java程序例。
3.1 Java源文件(Java Source Files)
每个Java源文件都包含一个单一的公共类或接口。假设私有
类和接口与一个公共类相关联。可以将它们和公共类放入同个源文
件。公共类必须是这个文件中的第一个类和接口。
Java源文件还遵循以下规那么：
◆开头注释(参见“开头注释〞)
◆包和引入语句(参见“包和引入语句)
◆类和接口声明(参见“类和接口声明)
开头注释(Beginning Comments)
所有的源文件都应该在开头有一个C语言风格的注释，其中列
出数出类名、版本信息，日期和声明：
/ *
* Classname
*
* Version information
*
* Date
*
* Copyright notice
* /
包和引入(Package and Import Statements)
在多数Java源文件中，第一个非注释行是包语句行。在它之
后可以跟引入语句。例如：
类和接口声明(Class and Interface Declarations)
下表描述了类和接口声明的免修局部以与它们出现的先后次
序。参见“Java源文件例〞中一个包含注释的例子。
类/接口声明的各局部 注解
package ;
2.2 常用文件名(Common File Names)
常用的文件名包括：
文件名 用途
GNUmakefile makefiles的首选文件名。我们采用
gnumake来创立(build)软件。
README 概述特定目录下所含容的文件的首选文
件名。
3. 文件组织(File Orgnization)
2 / 10
发布评论