《Sun - Java语言编码规范》由会员分享，可在线阅读，更多相关《Sun - Java语言编码规范（21页珍藏版）》请在金锄头文库上搜索。
1、Java语言编码规范(Java Code Conventions) 目录1.介绍(Introduction)31.1为什么要有编码规范(Why Have Code Conventions)31.2版权声明(Acknowledgments)32.文件名(File Names)32.1文件后缀(File Suffixes)32.2常用文件名(Common File Names)33.文件组织(File Organization)33.1Java源文件(Java Source Files)43.1.1开头注释(Beginning Comments)43.1.2包和引入语句(Package and I
2、mport Statements)43.1.3类和接口声明(Class and Interface Declarations)44.缩进排版(Indentation)54.1行长度(Line Length)54.2换行(Wrapping Lines)55.注释(Comments)75.1实现注释的格式(Implementation Comment Formats)85.1.1块注释(Block Comments)85.1.2单行注释(Single-Line Comments)85.1.3尾端注释(Trailing Comments)95.1.4行末注释(End-Of-Line Comments
3、)95.2文档注释(Documentation Comments)96.声明(Declarations)106.1每行声明变量的数量(Number Per Line)106.2初始化(Initialization)116.3布局(Placement)116.4类和接口的声明(Class and Interface Declarations)127.语句(Statements)127.1简单语句(Simple Statements)127.2复合语句(Compound Statements)127.3返回语句(return Statements)137.4if，if-else，if else-i
4、f else语句(if, if-else, if else-if else Statements)137.5for语句(for Statements)137.6while语句(while Statements)147.7do-while语句(do-while Statements)147.8switch语句(switch Statements)147.9try-catch语句(try-catch Statements)158.空白(White Space)158.1空行(Blank Lines)158.2空格(Blank Spaces)169.命名规范(Naming Conventions)1
5、610.编程惯例(Programming Practices)1710.1提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)1710.2引用类变量和类方法(Referring to Class Variables and Methods)1810.3常量(Constants)1810.4变量赋值(Variable Assignments)1810.5其它惯例(Miscellaneous Practices)1910.5.1圆括号(Parentheses)1910.5.2返回值(Returning Values)19
6、10.5.3条件运算符?前的表达式(Expressions before ? in the Conditional Operator)1910.5.4特殊注释(Special Comments)2011.代码范例(Code Examples)2011.1Java源文件范例(Java Source File Example)201. 介绍(Introduction)1.1 为什么要有编码规范(Why Have Code Conventions)编码规范对于程序员而言尤为重要，有以下几个原因：- 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发
7、人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。1.2 版权声明(Acknowledgments)本文档反映的是Sun MicroSystems公司，Java语言规范中的编码标准部分。主要贡献者包括：Peter King，Patrick Naughton，Mike DeMoney，Jonni Kanerva，Kathy Walrath以及Scott Hommel。本文档现由Scott Hommel维护，有
8、关评论意见请发至原文出处：http:/ 晨光（Morning）2. 文件名(File Names)这部分列出了常用的文件名及其后缀。2.1 文件后缀(File Suffixes)Java程序使用下列文件后缀：文件类别文件后缀Java源文件.javaJava字节码文件.class2.2 常用文件名(Common File Names)常用的文件名包括：文件名用途GNUmakefilemakefiles的首选文件名。我们采用gnumake来创建（build）软件。README概述特定目录下所含内容的文件的首选文件名3. 文件组织(File Organization)一个文件由被空行分割而成的段落以
9、及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。Java源文件范例提供了一个布局合理的Java程序范例。3.1 Java源文件(Java Source Files)每个Java源文件都包含一个单一的公共类或接口。若私有类和接口与一个公共类相关联，可以将它们和公共类放入同一个源文件。公共类必须是这个文件中的第一个类或接口。Java源文件还遵循以下规则：- 开头注释（参见开头注释）- 包和引入语句（参见包和引入语句）- 类和接口声明（参见类和接口声明） 3.1.1 开头注释(Beginning Comments)所有的源文件都应该在开头有一个C语言风格的注释，其中列出
10、类名、版本信息、日期和版权声明： /* * 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)下表描述了类和接口声明的各个部分以及它们出现的先后次序。参见J
11、ava源文件范例中一个包含注释的例子。类/接口声明的各部分注解1类/接口文档注释(/*/)该注释中所需包含的信息，参见文档注释2类或接口的声明3类/接口实现的注释(/*/)如果有必要的话该注释应包含任何有关整个类或接口的信息，而这些信息又不适合作为类/接口文档注释。4类的(静态)变量首先是类的公共变量，随后是保护变量，再后是包一级别的变量(没有访问修饰符，access modifier)，最后是私有变量。5实例变量首先是公共级别的，随后是保护级别的，再后是包一级别的(没有访问修饰符)，最后是私有级别的。6构造器7方法这些方法应该按功能，而非作用域或访问权限，分组。例如，一个私有的类方法可以置于
12、两个公有的实例方法之间。其目的是为了更便于阅读和理解代码。4. 缩进排版(Indentation)4个空格常被作为缩进排版的一个单位。缩进的确切解释并未详细指定(空格 vs. 制表符)。一个制表符等于8个空格(而非4个)。4.1 行长度(Line Length)尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。4.2 换行(Wrapping Lines)当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之：- 在一个逗号后面断开- 在一个操作符前面断开- 宁可选择较高级别(higher-level)的断
13、开，而非较低级别(lower-level)的断开- 新的一行应该与上一行同一级别表达式的开头处对齐- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。 以下是断开方法调用的一些例子： someMethod(longExpression1, longExpression2, longExpression3, longExpression4, longExpression5); var = someMethod1(longExpression1, someMethod2(longExpression2, longExpression3); 以下是两个断开算术表达式的
14、例子。前者更好，因为断开处位于括号表达式的外边，这是个较高级别的断开。 longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; /PREFFER longName1 = longName2 * (longName3 + longName4 - longName5) + 4 * longname6; /AVOID 以下是两个缩进方法声明的例子。前者是常规情形。后者若使用常规的缩进方式将会使第二行和第三行移得很靠右，所以代之以缩进8个空格 /CONVENTIONAL INDENTATION someMethod(int anArg, O
