程式碼規範之在函式之前添加註釋
阿新 • • 發佈:2019-02-19
開發中,我們常常要為自己寫的函式新增作者、引數的說明等資訊,可以採用如下的方式:
/** * @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; }
那麼,別的人呼叫該函式時,就會顯示相關釋義(包含作者,引數的資訊等),下面是滑鼠懸停後的效果: