Java 编程规范 小解

...这个编程规范的重要性...

前辈说得太多了...小弟就不罗嗦了...

就归结一句吧：让你的代码有质量，而不是垃圾

 

我贴上一段小弟写的，忘大家指点

 

类结构：

 

编程规范首先一点，就是类结构的合理

（如果你传源码给大牛看，别人一看你的包乱摆...估计也没什么心情)

 

com.emavaj.public_database.*

 上面的包名为：

 

com/cn/org/net.公司名/公司域名.项目名.具体模块名

 

代码:

	/**.
	 * 执行保存操作 (全部字段)
	 * 值传入的顺序要和数据库的字段顺序一致
	 * @param table 表名
	 * @param args 值
	 */
	public void save(final String table, final Object[] args) {
		try {
			List<String> fields = new ArrayList<String>();
			/**取得所有字段描述.*/
			ResultSet columns = this.connection.getMetaData().getColumns(null, null, table, "%");
			/**取得字段名.*/
			while (columns.next()) {
				String columnName = columns.getString(DataBaseUtil.COLUMN_NAME);
				log.info(columnName);
				/**拼接字段名.*/
				fields.add(columnName);
			}
			/**调用重载的保存操作函数*/
			this.save(table, fields.toArray(), args);
		} catch (SQLException e) {
			log.error("取得数据库元数据失败");
			e.printStackTrace();
		}
	}
	
	/**.
	 * 删除操作
	 * @param table 表名
	 * @param key 主键
	 */
	public void delete(final String table, final Object key) {
		try {
			/**取得主键名.*/
			ResultSet primaryKey = this.connection.getMetaData().getPrimaryKeys(null, null, table);
			primaryKey.next();
			String keyName = primaryKey.getString(DataBaseUtil.COLUMN_NAME);
			/**执行sql语句*/
			PreparedStatement statement = this.connection.prepareStatement("....");	
		} catch (SQLException e) {
			log.error("创建预编译sql失败");
			e.printStackTrace();
		}
	}

 说几点吧:

 

1) 每个方法上应该有 javadoc ，标明方法、参数、返回值作用等

2) javadoc 的第一行应该以 "." 结尾

3) 方法参数如果不用改变，那么需要声明为final

4) "=" 前后都需要有空格

5) 方法最后的 "{" 需要离开 ")" 一个空格

6) for、while、if、else 等，应该不紧贴 ")" 或者 "("，留一个空格

7) 括号内的参数或表达式等需紧贴 "("、")"

8) 代码中不能出现数字，除了 1、0、-1外，需要用常量代替 如: DataBaseUtil.COLUMN_NAME 值为 4

9) 参数的","、语句的";"，需要紧贴前面的参数，与后面参数隔开空格

10) 方法之间以空行隔开

11) 方法之内语句间不留空行，当然，逻辑块间可以用"//--------------" 隔开，并附上注释

12) ...

 

小弟只知道这些了，希望大家多指教

 

PS: 详细规范，请参照sun 的 checkstyle

myeclipse也有插件，可以检查你的代码规范性，并提供智能修复