java 语言编码规范

《java 语言编码规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、Java语言编码规范Java语言编码规范第8页Java语言编码规范目录一、规范简介11目的12范围13参考文档14说明1二、JAVA编码规范12缩进排版(Indentation)22.1行长度(LineLength)23注释(Comments)24声明(Declarations)34.1每行声明变量的数量(NumberPerLine)34.2初始化(Initialization)35空白(WhiteSpace)35.1空行(BlankLines)35.2空格(BlankSpaces)46命名规范(NamingConventions)47性能考虑57.

2、1使用StringBuffer对象57.2可移植性57.3换行57.4PrintStream6三、JSP编码规范6四、SERVLET编码规范7五、JSP和SERVLET编程注意事项7六、代码范例(CODEEXAMPLES)7第8页Java语言编码规范一、规范简介1目的制订本规范的目的是为培养规范设计和编程，养成良好的习惯，增强JAVA类软件产品的稳定、健壮、可靠性;同时也为提高软件的可读性，可以让程序员尽快而彻底地理解新的代码，使产品可维护性提高而制定的强制性规范，同时也是代码复审的依据。2范围本规范适用于公司JAVA类代码（包括JSP）的代码编写标

3、准。适用于代码编写阶段和代码维护阶段。3参考文档《SUNJAVA代码编写规范》。4说明本文档包括java编码规范，jsp编码规范，servlet编码规范。struts代码规范请参阅《struts编码规范.doc》。二、java编码规范1.1.1开头注释(BeginningComments)所有的源文件都应该在开头有一个Java语言风格的注释，其中列出标题、描述、日期和版权声明：/***

Title:标题

Description:描述

Copyright:Copyright(c)2007

Company:华

4、胜天成

5、行长度(LineLength)尽量避免一行的长度超过80个字符，因为很多终端和工具不能很好处理之。注意：用于文档中的例子应该使用更短的行长，长度一般不超过70个字符。3注释(Comments)Java程序原有两类注释：实现注释(implementationcomments)和文档注释(documentcomments)，我们自己又增加了一种注释叫标记注释。实现注释是那些在C++中见过的，使用/*...*/和//界定的注释。文档注释(被称为"doccomments")是Java独有的，并由/**...*/界定。文档注释可以通过javadoc工具转换成H

6、TML文件。实现注释用以注释代码或者实现细节。文档注释从实现自由(implementation-free)的角度描述代码的规范。它可以被那些手头没有源码的开发人员读懂。注释应被用来给出代码的总括，并提供代码自身没有提供的附加信息。注释应该仅包含与阅读和理解程序有关的信息。例如，相应的包如何被建立或位于哪个目录下之类的信息不应包括在注释中。在注释里，对设计决策中重要的或者不是显而易见的地方进行说明是可以的，但应避免提供代码中己清晰表达出来的重复信息。多余的的注释很容易过时。通常应避免那些代码更新就可能过时的注释。注意：第8页Java语言编码规范频繁的注

7、释有时反映出代码的低质量。当你觉得被迫要加注释的时候，考虑一下重写代码使其更清晰。注释不应写在用星号或其他字符画出来的大框里。注释不应包括诸如制表符和回退符之类的特殊字符。总之：注释要明确注明文件、页面、函数、算法之功能，用途，以及创建、修改信息等。1声明(Declarations)1.1每行声明变量的数量(NumberPerLine)推荐一行一个声明，因为这样以利于写注释。亦即，intlevel;//indentationlevelintsize;//sizeoftable要优于，intlevel,size;不要将不同类型变量的声明放在同一行，例如

8、：intfoo,fooarray[];//WRONG!注意：上面的例子中，在类型和标识符之间放了一个空格，另