用IDEA生成javadoc文档

举报
别团等shy哥发育 发表于 2023/02/05 16:55:28 2023/02/05
【摘要】 @[toc] 一、前言  javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。  javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。 ...

@[toc]

一、前言

  javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
  javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。

二、IDEA生成API的步骤

1、Tools->Genearte javaDoc

在这里插入图片描述

2、设置

在这里插入图片描述

1、参数解释:

  • locale:zh_CN:表示生成中文文档
  • encoding UTF-8:源代码使用UTF-8编码
  • charset UTF-8:表示生成的文本字符集使用UTF-8编码
  • windowtitle “title”:表示用浏览器打开时的窗口标题

2、生成文档

在这里插入图片描述

3、文档结构如下:

打开index.html即可查看生成的API
在这里插入图片描述

【版权声明】本文为华为云社区用户原创内容,未经允许不得转载,如需转载请自行联系原作者进行授权。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。