/**
* Title: User 类<br>
* Description: 通过 User 类说明 javadoc 如何使用<br>
* Copyright: http://hellojim.iteye.com<br>
* Company: hellojim <br>
* @author: jim
* @version:1.0
*/
public class User { //生成帮助文档时,class 前必须加上 public
private String username;
private String password;
/**
*这是 User 类的构造方法
*@param username 用户名
*@param password 密码
*/
public User(String username,String password) {
this.username = username;
this.password = password;
}
/**
*此方法用户获得一个用户
*@param type 获得的是普通用户还是管理员
*@return user 返回一个用户
*/
public User getUser(boolean type) {
if(type) {
return user;
}else {
return (Obj)user;
}
}
}
提醒:此外还要注意 (@author、@version、@param、@return 以及 /** */ )
这些最过运用 (javadoc -d help -version -author User.java) 这样的命令语句来生成帮助文档
使用javadoc工具生成类似 jdk API 形式的文档
最新推荐文章于 2022-01-27 00:37:59 发布