Java代码规范1

//RIGHT foo (long expression1, long_expression2, long_expression3, long_expression4); //RIGHT foo (long_expression1,
long_expression2, long_expression3, long_expression4); //RIGHT – blank line follows continuation line because same indent if (long_logical_test_1 || long_logical_test_2 ||long_logical_test_3) { statements; } 续行不能以二进制操作符打头；不要在没有空格出现的地方断行，如，在方 法名和其开括号之间；不能在开括号“{”之前断行，如： //WRONG while (long_expr1 || long_expr2 || long_expr3) { } //RIGHT
/** * Compute the total distance between a set of Points. *@param starshipCoordinates the locations of all know *@return the total distance */ 非 public 的声明也应该有简单的功能性说明。
1.3 Copyright / ID 块的注释
每个源文件应该以 Copyright/ID 块注释开始，内容包括版本信息和一个标准 的版权告示，版本信息的格式：
@(#) module version date [firstname lastname] module :源文件名 version: 版本管理系统中的文件版本 date: 最近修改的日期 firstname lastname：(可选项)
如： a += c[I + j] + (int)d + foo(bar(I + j), e); a = (a + b) / (c * d); if (((X + Y) > (Z + W)) || (a != (b + 3))) { return foo.distance(X, Y); }
3.3 缩进和续行
2.4 方法命名
方法命名应该以首字母小写、后续单词首字母大写，也包括只取首字母的缩 写词；其他字符均小写；不要用下划线将单词分开；命名应该用及物动词或动词 词组。如：
//GOOD method names: showStatus(),drawCircle(),addLayoutComponet() //Bad method names: mouseButton(),DrawCirle()，serverRunning() 方 法 中 要 获 得 或 设 置 一 些 类 的 属 性 时 ， 应 该 写 成 getProperty() 或 setProperty(),如： getHeight(),setHeight() 当方法之目的是测试类的 boolean 属性时，应该写成:isProperty(),如： isResizable(),isVisible()
import java.applet.Applet; import java.awt.Point; 在 import 声明中不主张用通配符。如： import java.util.*
1.6 Class/interface 的声明
class/interface 的声明在 import 声明之后，这些定义在源文件中应尽量少；最 多只能有一个 public 类型的声明，且该声明要放于所有 class/interface 之前。 在 public 声明前应该有一段文档注释，描述其功能和参数（用@param 为标志），要 尽量简要。如：
3 空格和空行的使用
3.1 空行
将代码按照逻辑关联分组，组之间以空行分开可以提高可读性。在下列情况 下也应该用空行：
1. 在版权块的注释后、package 声明后、import 段的声明后。 2. 在两个类声明之间。 3. 在两个方法声明之间。 4. 在类内的最后一个域定义和第一个方法声明之间。 5. 在一个块或单行注释前，除非它们是块中的第一行。
标志的使用： 1. 类和接口注释可能按顺序用到标志： @version,@auther, @see，如有多作者用@auther 分开； 2. 构造函数注释可能按顺序用到标志： @param,@exception,@see 3. 方法注释可能按顺序用到标志： @param,@return,@exception,@see 4. 变量注释只能用标志: @see 文本注释以字符*/结尾，为了有助于辨别也可以用**/。 一个方法示例： /** * Checks a object for “coolness”. Performs a comprehensive * coolness analysis on the object. …..in its own right. * * @param obj the object to check for coolness * @return true if the object is cool; false otherwise.
package ng 建议按公司立项产品名组织 package 名,如: package com.card
1.5 Import declaration
import 声明应从第一列开始，和名字间以一个空格分开,并以 package 名分组, 各组间以一空行分隔.组内部的 import 声明应按照字母排序。如：
XXX.equals(new String(VALUE))
if (a == VALUE) { return TRUE;
} else { return isPrime(a);
}
单字符域名应该避免，除临时变量和循环变量。在这种情况下原则是： b for a byte c for a char d for a double e for an Exception object f for a float g for a Graphics object i,j,k,m,n for integers p,q,r,s for String,StringBuffer,or char[] objects 还有一种例外就是 X 和 Y 表示屏幕坐标。避免变量小写“l”，因为其在一些 打印机打印和显示时和“1”很难分清。
/* * @(#) CodingStyleExample.java 1.0 2008/02/23 du_cloud * * Copyright (c) 2008 hime. All Right Reserver. */
1.4 Package declaration
每个源文件应该包含一个 package 的声明。Package 应该从第一列开始， package 名和 package 之间以一空格分开,应由小写字母和“.”组成 如：
JAVA 语言编程规范
1 源文件Leabharlann 1.1 源文件命名Java 源文件的命名格式： ClassOrInterfaceName.java
1.2 源文件的组织
Java 源程序应该包含下列元素，在下列顺序： 1. Copyright/ID block comment 2. package declaration 3. import declaration 4. one or more class/interface declaration 不同的元素之间至少应该有一空行。
Searchable,Sortable,NetwokAccessible 否则用名词或名词词组。 例如： //GOOD type names; LayoutManage,AWTException ArrayIndexOutOfBoundException //BAD type names; ManageLayout awtException array_index_out_of_bounds_exception
2 命名约定
2.1 Package 命名
package 的命名应该用小写字母和数字，没有下划线。如： ng java.awt.image
2.2 Class/interface 的命名
应该以首字母大写、后续单词首字母大写，也包括只取首字母的缩写词，其 他字符均小写，不要用下划线将字母分开，class 命名应该用名词或名词词组。 interface 的命名应该以易读为目的，如果该 interface 的目的是为了赋予某一对象 以特殊的 capability，那么就应该以描述 capability 的形容词来命名。如：
文本注释应该在定义的实体之前，他们之间没有空行。注释的第一行应该是 /**，没其他内容。但应该与下面的定义实体对齐。接下来行的行首包含一个星 号，后跟一空格，再后是注释内容，且应和第一行的星号对齐。第一行的注释是 注释本身的小结，注释文本中的句号后应该是一空格、TAB 或新的一行，注释 文本中可以插入 HTML 标记，除标记：<H1>,<H2>,<H3>,<H4>,<H5>,<H6>,<HR> 外。
while (long_expr1 || long_expr2 ||long_expr3) { }
4 注释
4.1 通用规则和定义
JAVA 支持文本注释、块注释、单行注释和行尾注释，其原则是： 采用 Doxygen 支持的 JavaDoc Style 来注释，可用于自动生成程序说明文档；
4.2 文本注释
行缩进总是四个空格。 代码行被限制在 80 列（对于非 ASCⅡ来说并非 80 个字节）。超过 80 列应划分成一个或多个续行，续行之间应该对齐，行缩进从第 一个续行开始。缩进的多少依赖于声明（statement）的类型。 如果声明在圆括 号的表达式中间续行，如，复杂声明和参数列表的方法，续行应该和第一行左括 号的第一个字符对齐。其他的情况，续行应该保持标准的缩进 4 个空格。如果下 一声明的缩进和前一声明的缩进相同，那么在开大括号后应有一空行，以避免混 淆。 例如：