JAVA规范
1. Package 的命名 Package 的名字应该都是由小写单词组成。 package com.neu.util 2. Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母。 public class ThisAClassName{} 3. Class 变量的命名 变量的名字必须用一个小写字母开头。后面的单词用大写字母开头,如 userName , thisAClassMethod 4. Static Final 变量的命名 static Final 变量的名字应该都大写,并且指出完整含义。 /** *DBConfig PATH **/ public static final String DB_CONFIG_FILE_PATH ="com.neu.etrain.dbconfig"; 5. 数组的命名 数组应该总是用下面的方式来命名: byte[ ] buffer; 而不是: byte buffer[]; 6, 方法的参数 使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字: SetCounter(int size){ this.size = size; } 7, {} 对 {} 中的语句应该单独作为一行. 例如, 下面的第1行是错误的, 第2行是正确的: if (i>0) { i ++ }; // 错误, { 和 } 在同一行 if (i>0) { i ++ }; // 正确, { 单独作为一行 } 语句永远单独作为一行. } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。 8.括号 左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用: CallProc( AParameter ); // 错误 CallProc(AParameter); // 正确 9, Java的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种? // 注释一行 /* ...... */ 注释若干行 不完全对,除了以上两种之外,还有第三种,文档注释: /** ...... */ 注释若干行,并写入 javadoc 文档 Java代码规范 --注释 @author LEI @version 1.10 2005-09-01 1 注释文档的格式 注释文档将用来生成HTML格式的代码报告,所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。 例如: /** * The doGet method of the servlet. * This method is called when a form has its tag value method equals to get. * * @param request * the request send by the client to the server * @param response * the response send by the server to the client * @throws ServletException * if an error occurred * @throws IOException * if an error occurred */ public void doGet (HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doPost(request, response); } 前两行为描述,描述完毕后,由@符号起头为块标记注视。 2 注释的种类 2.1 文件头注释 文件头注释以 /*开始,以*/结束,需要注明该文件创建时间,文件名,命名空间信息。 例如: /* * Created on 2005-7-2 * / 2.2 类、接口注释 类、接口的注释采用 /** … */,描述部分用来书写该类的作用或者相关信息,块标记部分必须注明作者和版本。 例如: /**Title: XXXX DRIVER 3.0 *Description: XXXX DRIVER 3.0 *Copyright: Copyright (c) 2003 *Company:XXXX有限公司 * * @author Java Development Group * @version 3.0 */ 例如: /** * A class representing a window on the screen. * For example: * * Window win = new Window(parent); * win.show(); * * * @author Sami Shaio * @version %I%, %G% * @see java.awt.BaseWindow * @see java.awt.Button */ class Window extends BaseWindow { ... } 2.3 构造函数注释 构造函数注释采用 /** … */,描述部分注明构造函数的作用,不一定有块标记部分。 例如: /** * 默认构造函数 */ 有例如: /** * 带参数构造函数,初始化模式名,名称和数据源类型 * * @param schema * Ref 模式名 * @param name * Ref 名称 * @param type * byVal 数据源类型 */ 2.4 域注释 域注释可以出现在注释文档里面,也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面,而使用/* … */的注释会被忽略。 例如: /* 由于triger和表用一个DMSource,所以要区分和表的迁移成功标记 */ boolean isTrigerSuccess = false; 又例如: /** 由于triger和表用一个DMSource,所以要区分和表的迁移成功标记 */ boolean isTrigerSuccess = false; 再例如: /** * The X-coordinate of the component. * * @see #getLocation() */ int x = 1263732; 2.5 方法注释 方法注释采用 /** … */,描述部分注明方法的功能,块标记部分注明方法的参数,返回值,异常等信息。例如: /** * 设置是否有外码约束 * * @param conn * Connection 与数据库的连接 */