代码规范之在函数之前添加注释

来源：互联网发布：php 多图片上传插件编辑：程序博客网时间：2024/06/05 07:20

开发中，我们常常要为自己写的函数添加作者、参数的说明等信息，可以采用如下的方式：

/** * @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;}

那么，别的人调用该函数时，就会显示相关释义（包含作者，参数的信息等），下面是鼠标悬停后的效果：

0 0