JAVA程序编码要求规范

《JAVA程序编码要求规范》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、实用JAVA程序编码规范目录JAVA程序编码规范11简介31.1目的31.2范围31.3Tab31.4缩进31.5空行31.6代码块长度31.7行宽31.8空格32注释52.1注释的基本约定52.2注释类型5文档实用2.3注释那些部分53命名73.1命名的基本约定73.2标识符的命名约定74声明95表达式和语句105.1每行应该只有一条语句。105.2if-else105.3for语句105.4while语句105.5do-while语句105.6switch语句115.7try-catch语句116错误处理和异常事件127可移植性13

2、7.1尽量不要使用已经被标为不赞成使用的类或方法。137.2代码应遵循UNIX风格。137.3如果需要换行的话，尽量用println来代替在字符串中使用""。137.4用separator()方法代替路径中的”/”或””。137.5用pathSeptarator()方法代替路径中的”:”或”;”。13文档实用8JAVA 文件样式148.1版权信息148.2Package/Imports148.3Class148.4Class Fields158.5存取方法158.6构造函数158.7克隆方法168.8类方法168.9toString

3、 方法178.10main 方法179程序编写规范189.1exit()189.2垃圾收集189.3Clone189.4final 类199.5访问类的成员变量1910编程技巧2010.1byte 数组转换到characters2010.2Utility 类2010.3初始化20文档实用10.4枚举类型2010.5Swing2010.6调试2110.7性能2110.8使用 StringBuffer 对象2110.9避免太多的使用 synchronized 关键字2210.10可移植性2210.11换行22文档实用1简介1.1目的本规范为

4、一套编写高效可靠的Java代码的标准、约定和指南。它以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强，提高生产效率。同时，将带来更大的一致性，使软件开发团队的效率明显提高。1.2范围本规范应用于采用J2EE规范的项目中，所有项目中的JAVA代码（含JSP,SERVLET,JAVABEAN）均应遵守这个规范。同时，也可作为其它项目的参考。代码组织与风格1.3Tab一个Tab为4个空格长。1.4缩进一个代码块内的代码都应该统一的缩进一个Tab长度。1.5空行适当的增加空行，来增加代码的可读性。在下列情况下应该有两行空行：     

5、   同一文件的不同部分之间；        在类，接口以及彼此之间；在下列情况之间应该有一行空行：        方法之间；        局部变量和它后边的语句之间；文档实用        方法内的功能逻辑部分之间；1.1代码块长度每个代码块尽量控制在1个屏幕之内，方便浏览。1.2行宽每行代码和注释不应超过70个字节或屏幕的宽度，如超过则应换行，换行后的代码应该缩进8个字符。1.3空格括号和它里面的字符之间不应该出现空格。括号应该和它前边的关键词留有空格，如：while(true){};但是方法名和左括号之间不应该有空格。参数之间的

6、逗号后应该加一空格。如：method1(inti1,inti2)for语句里的表达式之间加一空格。如：for(expr1;expr2;expr3)二元操作符和操作数之间应该用空格隔开。如：i+c;强制类型转换时，在类型和变量之间加一空格。如：(int)i;注释1.4注释的基本约定注释应该增加代码的清晰度持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性。注释不应该包括其他的特殊字符。先写注释，后写代码文档实用1.1注释类型块注释：主要用来描述文件，类，方法，算法等。一般用在文档和方法的前面，也可以放在文档的任何地方

7、。以‘/*’开头，‘*/’结尾。例：……/**注释*/……行注释：主要用在方法内部，对代码，变量，流程等进行说明。与块注释格式相似，但是整个注释占据一行。例：……/*注释*/……尾随注释：与行注释功能相似，放在代码的同行，但是要与代码之间有足够的空间，便于分清。例：intm=4;/*注释*/如果一个程序块内有多个尾随注释，每个注释的缩进应该保持一致。行尾注释：与行注释功能相似，放在每行的最后，或者占据一行。以‘//’开头。文档注释：与块注释相似，但是可以被javadoc处理，生成HTML文件。以‘/**’开头，‘*/’结尾。问挡住是不能

8、放在方法或程序块内。例：/***注释文档实用*/1.1注释那些部分项目注释哪些部分实参/参数参数类型参数用来做什么任何约束或前提条件示例字段/字段/属性字段描述注释所有使用的不变量示例并行事件可见性决策类类