JavaDoc几种文档生成方式

JavaDoc几种文档生成方式

​ JavaDoc命令是用来生成自己的API文档的

  • 注释参数信息
  • @author 作者名
  • @version 版本号
  • @since 指明需要最早使用的jdk版本
  • @param 参数名
  • @return 返回值情况
  • @throws 异常抛出情况
生成文档

方法一:

  1. 打开CMD界面

  2. 进入java文件的真实目录内

  3. 输入命令:javadoc -encoding UTF-8 -charset UTF-8 java文件名

    encoding与charset都是设置编码,使之适应中文

方法二使用eclipse生成文档:

  1.  选择菜单栏Project下的Generate Javadoc出现如下界面:
    

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-73pEzR1i-1587462960714)(C:\Users\Administrator\Desktop\屏幕截图1.jpg)]

  2. 上图界面javadoc command设置为jdk\bin目录下的javadoc。exe,然后选中要生成文档的目标,点击next

  3. 第二页不做修改,继续next进入如下界面

    [外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-oHuaLfnm-1587462960719)(C:\Users\Administrator\Desktop\屏幕截图.jpg)]

  4. 在中间的大空白区域如上图输入-encoding UTF-8 -charset UTF-8,解决中文编码问题,点击finish

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值