《Sun_Java编码规范中文版》.pdf

Java语言编码规范(Java Code Conventions) 简介 ： 本文档讲述了Java语言的编码规范，较之陈世忠先生《c++编码规范》的浩繁详尽， 此文当属短小精悍了。而其中所列之各项条款，从编码风格，到注意事项，不单只 Java，对于其他语言，也都很有借鉴意义。因为简短，所以易记，大家不妨将此作 为handbook，常备案头，逐一对验。 声明： 如需复制、传播，请附上本声明，谢谢。 原文出处：/docs/codeconv/html/CodeConvTOC.doc.html， 译文出处：/，moyingzz@ 目录 Java 语言编码规范(Java Code Conventions) 1 2.1 文件后缀(File Suffixes) 2 2.2 常用文件名(Common File Names) 2 3.1.1 开头注释(Beginning Comments) 3 3.1.2 包和引入语句(Package and Import Statements) 3 3.1.3 类和接口声明(Class and Interface Declarations)4 5.1.1 块注释(Block Comments) 7 5.1.2 单行注释(Single-Line Comments) 8 5.1.3 尾端注释(Trailing Comments) 8 5.1.4 行末注释(End-Of-Line Comments) 9 6.1 每行声明变量的数量(Number Per Line) 10 7.1 简单语句(Simple Statements) 12 7.2 复合语句(Compound Statements) 12 7.4 if，if-else，if else-if else 语句(if, if-else, if else-if else Statements)... 13 7.6 while 语句(while Statements) 14 7.7 do-while 语句(do-while Statements) 14 7.8 switch 语句(switch Statements) 14 7.9 try-catch 语句(try-catch Statements) 15 8.1 空行(Blank Lines) 16 8.2 空格(Blank Spaces) 16 10.2 引用类变量和类方法(Referring to Class Variables and Methods) 19 10.3 常量(Constants) 19 10.4 变量赋值(Variable Assignments) 19 11.1 Java 源文件范例(Java Source File Example) 21 1 介绍(Introduction) 1.1 为什么要有编码规范(Why Have Code Conventions) 编码规范对于程序员而言尤为重要，有以下几个原因： - 一个软件的生命周期中，80%的花费在于维护 - 几乎没有任何一个软件，在其整 个生命周期中，均由最初的开发人员来维护 - 编码规范可以改善软件的可读性，可 以让程序员尽快而彻底地理解新的代码 - 如果你将源码作为产品发布，就需要确任 它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。 1.2 版权声明(Acknowledgments) 本文档反映的是Sun MicroSystems公司，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