博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
eclipse中javadoc给项目生成api文档
阅读量:7238 次
发布时间:2019-06-29

本文共 566 字,大约阅读时间需要 1 分钟。

步骤

1.打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/

 2.javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。

 3.点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。

 4.(1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。

(5)点击【Next】按钮

 5.(1)勾选Document Title,然后填写文档标题。

(2)点击【Next】按钮

 6.

(1)选择使用的jdk版本

(2)点击【Finish】按钮

 7.

可以看到控制台输出生成javadoc的信息。

 8.

项目下生成一个【doc】的目录,里面存放着javadoc文档。

 9.

打开doc目录,用浏览器打开index.html

 

注意点

有的时候生成的文档是中文乱码的,这个时候在第六步的时候需要加上-encoding UTF-8 -charset UTF-8

 

 

转载地址:http://bhrfm.baihongyu.com/

你可能感兴趣的文章
escape(s, t)函数的实现
查看>>
WIN内核线程池函数
查看>>
机器学习常见算法个人总结(面试用)
查看>>
T4 好用的Vs扩展
查看>>
Swift3.0 split函数切割字符串
查看>>
字典树
查看>>
单例模式的七种写法
查看>>
extjs_08_界面布局
查看>>
卷积神经网络(CNN)代码实现(MNIST)解析
查看>>
git 在命令行与图形状态下使用详情
查看>>
爱上MVC~Web.Config的Debug和Release版本介绍
查看>>
linux操作系统中oracle数据库的密码过期问题解决
查看>>
Spring中Bean的五个作用域
查看>>
hadoop之 distcp(分布式拷贝)
查看>>
Java后端程序员1年工作经验总结
查看>>
使用Vundle管理配置Vim的插件
查看>>
JDBC连接池&DBUtils使用
查看>>
可以通过shadowserver来查看开放的mdns(用以反射放大攻击)——中国的在 https://mdns.shadowserver.org/workstation/index.html...
查看>>
IOS系统控件高度
查看>>
Flink - ResultPartition
查看>>