java程序编码规范.doc

JAVA程序编码规目录JAVA程序编码规 11 简介 目的 围 Tab 缩进 空行 代码块长度 行宽 空格 32 注释 注释的基本约定 注释类型 注释那些部分 53 命名 命名的基本约定 标识符的命名约定 74 声明 95 表达式和语句 每行应该只有一条语句。 if-else for语句 while语句 do-while语句 switch语句 try-catch语句 116 错误处理和异常事件 127 可移植性 尽量不要使用已经被标为不赞成使用的类或方法。 代码应遵循UNIX风格。 如果需要换行的话,尽量用println来代替在字符串中使用"\n"。 用separator()方法代替路径中的”/”或””。 用pathSeptarator()方法代替路径中的”:”或”;”。 138 JAVA 文件样式 信息 Package/Imports Class Class Fields 存取方法 构造函数 克隆方法 类方法 toString 方法 main 方法 179 程序编写规 exit() 垃圾收集 Clone final 类 访问类的成员变量 1910 编程技巧 byte 数组转换到characters Utility 类 初始化 枚举类型 Swing 调试 性能 使用 StringBuffer 对象 避免太多的使用 synchronized 关键字 可移植性 换行 22简介目的本规为一套编写高效可靠的Java代码的标准、约定和指南。它以安全可靠的软件工程原则为基础,使代码易于理解、维护和增强,提高生产效率。同时,将带来更大的一致性,使软件开发团队的效率明显提高。围本规应用于采用J2EE规的项目中,所有项目中的JAVA代码(含JSP,SERVLET,JAVABEAN)均应遵守这个规。同时,也可作为其它项目的参考。代码组织与风格Tab一个Tab为4个空格长。缩进一个代码块的代码都应该统一的缩进一个Tab长度。空行适当的增加空行,来增加代码的可读性。在下列情况下应该有两行空行:        同一文件的不同部分之间;        在类,接口以及彼此之间;在下列情况之间应该有一行空行:        方法之间;        局部变量和它后边的语句之间;        方法的功能逻辑部分之间;代码块长度每个代码块尽量控制在1个屏幕之,方便浏览。行宽每行代码和注释不应超过70个字节或屏幕的宽度,如超过则应换行,换行后的代码应该缩进8个字符。空格括号和它里面的字符之间不应该出现空格。括号应该和它前边的关键词留有空格,如:while(true){};但是方法名和左括号之间不应该有空格。参数之间的逗号后应该加一空格。如:method1(inti1,inti2)for语句里的表达式之间加一空格。如:for(expr1;expr2;expr3)二元操作符和操作数之间应该用空格隔开。如:i+c;强制类型转换时,在类型和变量之间加一空格。如:(int)i;注释注释的基本约定注释应该增加代码的清晰度持注释的简洁,不是任何代码都需要注释的,过多的注释反而会影响代码的可读性。注释不应该包括其他的特殊字符。先写注释,后写代码注释类型块注释:主要用来描述文件,类,方法,算法等。一般用在文档和方法的前面,也可以放在文档的任何地方。以‘/*’开头,‘*/’结尾。例:……/** 注释*/……行注释:主要用在方法部,对代码,变量,流程等进行说明。与块注释格式相似,但是整个注释占据一行。例:……/* 注释 */……尾随注释:与行注释功能相似,放在代码的同行,但是要与代码之间有足够的空间,便于分清。例:intm=4; /* 注释 */如果一个程序块有多个尾随注释,每个注释的缩进应该保持一致。行尾注释:与行注释功能相似,放在每行的最后,或者占据一行。以‘//’开头。文档注释:与块注释相似,但是可以被javadoc处理,生成HTML文件。以‘/**’开头,‘*/’结尾。问挡住是不能放在方法或程序块。例:/*** 注释*/注释那些部分项目注释哪些部分实参/参数参数类型参数用来