使用javadoc工具生成类似 jdk API 形式的文档

/** 
* 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) 这样的命令语句来生成帮助文档
 
  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值