代碼規範之在函數之前添加註釋

開發中，我們常常要爲自己寫的函數添加作者、參數的說明等信息，可以採用如下的方式：

	/**
	 * @author 小明（我的工位a89）
	 * @param name:用戶名
	 * @param passwd:密碼
	 * @param email:
	 * @param grade
	 * @return boolean:如果true：說明添加成功，false:添加不成功
	 */
	
	//添加用戶
	public boolean addUser(String name,String passwd,String email,String grade){
		boolean b=false;
		
		try{
			ct=new ConnDB().getConn();
			
			sm=ct.createStatement();
			//執行
			
			int a=sm.executeUpdate("insert into users(username,passwd,email,grade) values('"+name+"','"+passwd+"','"+email+"','"+grade+"')");
			if(a==1){
				//刪除成功
				b=true;
			}
			
			
		}catch(Exception ex){
			ex.printStackTrace();
		}finally{
			this.close();
		}
		return b;
	}

那麼，別的人調用該函數時，就會顯示相關釋義（包含作者，參數的信息等），下面是鼠標懸停後的效果：