首页 > 编程语言 > 详细

Java根据文档注释生成API说明文档

时间:2021-05-20 00:24:10      阅读:20      评论:0      收藏:0      [点我收藏+]

 

1. API注释

 技术分享图片

 

 

 

2. 通过IDEA生成API说明文档

(1) 路径“Tools”->“Generate JavaDoc…”

 技术分享图片

 

 标红处说明:

l 需要生成文档的文件路径

l 生成文档的存放路径

文档编码格式(Windows默认是GBK)

zh_CN

-encoding UTF-8 -charset UTF-8

 

(2) 点击“OK”,开始执行,生成文档。

 技术分享图片

 

 

(3) 文档打开页面如下:

 技术分享图片

 

 

3. 通过命令生产文档

javadoc -locale zh_CN -protected -splitindex -author -encoding UTF-8 -charset UTF-8 -d E:\workspace\myDoc\doc_dms_test

Java根据文档注释生成API说明文档

原文:https://www.cnblogs.com/gongxr/p/14786296.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!