sun公司推荐的Java编码规范.doc

Java编码规范 Java编码规范 1 1. 说明 3 1.1 为什么要有编码规范 3 1.2 版权声明 3 2. 文件名(File Names) 3 2.1 文件后缀(File Suffixes) 3 3.1 Java源文件(Java Source Files) 3 3.1.1 开头注释(Beginning Comments) 3 3.1.2 包和引入(Package and Import Statements) 3 3.1.3 类和接口声明(Class and Interface Declarations) 3 4.1 行长度 3 4.2 换行(Wrapping Lines) 3 // CONVENTION INDENTATION 4 Object andStillAnother) { 4 || !(condition5 condition6)) { 4 5. 注释(Comments) 4 5.1 实现注释的格式(Implementation Comment Formats) 4 5.1.1 块注释 4 5.1.2 单行注释(Single-Line Comments) 5 5.1.3 尾端注释(Trailing Comments) 5 5.1.4 行末注释(End-Of-Line Comments) 5 5.2 文档注释(Documentation Comments) 5 6. 声明(Declaration) 5 6.1 每行声明变量的数量(Number Per Line) 5 6.2 初始化(Initialization) 6 6.3 布局(Placement) 6 7.1 简单语句(Single Statement) 6 7.2 复合语句(Compound Statements) 6 7.3 返回语句(return Statements)s 6 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) { 7 7.5 for语句(for Statements) 7 7.6 while语句(while Statements) 7 7.7 do-while语句(do-while Statements) 7 7.8 switch语句(switch Statements) 7 7.9 try-catch语句(try-catch Statements) 7 } catch (ExceptionClass e) { 7 } catch (ExceptionClass e) { 7 } finally { 7 8. 空白(White Space) 7 8.1 空行(Blank Lines) 7 8.2 空格(Blank Spaces) 7 9. 命名规范(Naming Convention) 8 10. 编程惯例(Programming Practices) 8 10.1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables) 8 10.2 引用类变量和类方法(Referring to Class Variables and Methods) 8 10.4 变量赋值(Variable Assignments) 8 10.5 其它惯例(Miscellaneous Practices) 9 10.5.1 圆括号(Parentheses) 9 10.5.2 返回值(Returning Values) 9 10.5.3 条件运算符“?”前的表达式(Expressions before “?” in the Conditional Operator) 9 10.5.4 特殊注释(Special Comments) 9 11. 代码范例(Code Examples) 9 11.1 Java源文件范例(Java Source File Example) 9  1. 说明 1.1 为什么要有编码规范 编码规范对于程序员而言尤为重要，有以下几个原因： ◆ 一个软件的生命周期中，80%的花费在于维护。 ◆ 几乎没有任何一个软件，在其整个生命同期中，均由最初的开发人员来维护。 ◆ 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新代码。 ◆ 如果你将源码作为产品发布，就需要确认它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品。 为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人!!! 1.2 版权声明 本文档反映的是Sun M