Sun-Java语言编码规范 精品资料

Java语言编码规范(JavaCodeConventions)目录1.介绍(Introduction)31.1为什么要有编码规范(WhyHaveCodeConventions)31.2版权声明(Acknowledgments)32.文件名(FileNames)32.1文件后缀(FileSuffixes)32.2常用文件名(CommonFileNames)33.文件组织(FileOrganization)33.1Java源文件(JavaSourceFiles)43.1.1开头注释(BeginningCom|ments)43.1.2包和引入语句(PackageandImportStatements)43.1.3类和接口声明(ClassandInterfaceDeclarations)44.缩进排版(Indentation)54.1行长度(LineLength)54.2换行(WrappingLines)55.注释(Comments)75.1实现注释的格式(ImplementationCommentFormats)85.1.1块注释(BlockComments)85.1.2单行注释(Single-LineCom|ments)85.1.3尾端注释(TrailingComments)95.1.4行末注释(End-Of-LineComments)95.2文档注释(DocumentationComments)96.声明(Declarations)106.1每行声明变量的数量(NumberPerLine)106.2初始化(Initialization)116.3布局(Placement)11

16.4类和接口的声明(ClassandInterfaceDeclarations)127.语句(Statements)127.1|简单语句(SimpleStatements)127.2复合语句(CompoundStatements)127.3返回语句(returnStatements)137.4if，if-else，ifelse-ifelse语句(if,if-else,ifelse-ifelseStatements)137.5for语句(forStatements)137.6while语句(whileStatements)147.7do-while语句(do-whileStatements)147.8switch语句(switch|Statements)147.9try-catch语句(try-catchStatements)158.空白(WhiteSpace)158.1空行(BlankLines)158.2空格(BlankSpaces)169.命名规范(NamingConventions)1610.编程惯例(ProgrammingPractices)1710.1提供对实例以及类变量的访问控制(ProvidingAccesstoInstanceandClassVariables)1710.2引用类变量和类方法(Referringt|oClassVariablesandMethods)1810.3常量(Constants)1810.4变量赋值(VariableAssignments)1810.5其它惯例(MiscellaneousPractices)1910.5.1圆括号(Parentheses)1910.5.2返回值(ReturningValues)1910.5.3条件运算符"?"前的表达式(Expressionsbefore'?'intheConditionalOperator)1910.5.4特殊注释(SpecialComme|nts)2011.代码范例(CodeExamples)2011.1Java源文件范例(JavaSourceFileExample)20

21.介绍(Introduction)1.1为什么要有编码规范(WhyHaveCodeConventions)编码规范对于程序员而言尤为重要，有以下几个原因：-一个软件的生命周期中，80%的花费在于维护-几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护-编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码-如果你将源码作为产品发布，就需要|确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。1.2版权声明(Acknowledgments)本文档反映的是SunMicroSystems公司，Java语言规范中的编码标准部分。主要贡献者包括：PeterKing，PatrickNaughton，MikeDeMoney，JonniKanerva，KathyWalrath以及ScottHommel。本文档现由ScottHommel维护，有关评论意见请发至shommel@eng.su|n.com原文出处：http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html，译文出处：http://morningspace.51.net/，moyingzz@etang.com译者晨光（Morning）2.文件名(FileNames)这部分列出了常用的文件名及其后缀。2.1文件后缀(FileSuffixes)Java程序使用下列文件后缀：文件类别文件后缀Java源文件.javaJava字节码文件.class2.2常用文件名(CommonF|ileNames)常用的文件名包括：文件名用途GNUmakefilemakefiles的首选文件名。我们采用gnumake来创建（build）软件。README概述特定目录下所含内容的文件的首选文件名

31.文件组织(FileOrganization)一个文件由被空行分割而成的段落以及标识每个段落的可选注释共同组成。超过2000行的程序难以阅读，应该尽量避免。"Java源文件范例"提供了一个布局合理的Java程序范例。1.1