IT数码 购物 网址 头条 软件 日历 阅读 图书馆
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
图片批量下载器
↓批量下载图片,美女图库↓
图片自动播放器
↓图片自动播放器↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁
 
   -> 开发工具 -> JavaDoc文件的生成与查找 -> 正文阅读

[开发工具]JavaDoc文件的生成与查找

JavaDox文件的生成和查找

一. 参数信息和示例

加在类上面就是类的注释,加在方法上就是方法的注释

新建一个class,然后在package下面写如下代码

/**
 * @author dabihu
 * @version 1.0
 * @since 1.8
 */

@author代表作者名

@version代表版本名

@since代表需要最早使用的jdk版本

public class Doc {
?
 ? ?String name;//属性
?
 ? ?/**
 ? ? *
 ? ? * @param name
 ? ? * @return
 ? ? * @throws Exception
 ? ? */
?
 ? ?public String test(String name) throws Exception{
 ? ? ? ?return name;
 ?  }//方法

@param代表参数名

@return 代表返回值情况

@throws代表异常抛出情况



二. 查找JavaDoc文件

JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。

1)通过命令行查找JavaDoc文件

右击Doc文件,进行以下操作

?

点开Explorer,再在文件夹索引框最前面加上cmd+空格

打开命令框之后输入javadoc -encoding UTF-8 -charset UTF-8 Doc.java

?

可以发现生成了htlm文件

然后再返回我们刚刚打开的文件

?

然后打开index.html文件(index是首页的意思)

?

然后就可以找到JavaDoc文件了

2)使用IDEA生成JavaDoc文档

点开Tool

?

?

  1. 第一步:选择局部还是整体,选择生成JavaDoc文档的范围,我只对一个源文件生成Doc,所以选择文件

  2. 第二步:选择文件生成的位置

  3. 第三步:区域设置,决定文档的语言,简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww。我们一般会使用zh_CN。

  4. 第四步:其他命令行参数:如果区域设置为中国,参数一般为 -encoding UTF-8 -charset UTF-8 主要意义是为了显示中文不出现乱码。

  5. 第五步:点击确定就可以了

然后就会出现以下界面

?

这样就得到了我们生成的生成的文档了(index.html )

  开发工具 最新文章
Postman接口测试之Mock快速入门
ASCII码空格替换查表_最全ASCII码对照表0-2
如何使用 ssh 建立 socks 代理
Typora配合PicGo阿里云图床配置
SoapUI、Jmeter、Postman三种接口测试工具的
github用相对路径显示图片_GitHub 中 readm
Windows编译g2o及其g2o viewer
解决jupyter notebook无法连接/ jupyter连接
Git恢复到之前版本
VScode常用快捷键
上一篇文章      下一篇文章      查看所有文章
加:2021-10-04 13:02:21  更:2021-10-04 13:03:31 
 
开发: C++知识库 Java知识库 JavaScript Python PHP知识库 人工智能 区块链 大数据 移动开发 嵌入式 开发工具 数据结构与算法 开发测试 游戏开发 网络协议 系统运维
教程: HTML教程 CSS教程 JavaScript教程 Go语言教程 JQuery教程 VUE教程 VUE3教程 Bootstrap教程 SQL数据库教程 C语言教程 C++教程 Java教程 Python教程 Python3教程 C#教程
数码: 电脑 笔记本 显卡 显示器 固态硬盘 硬盘 耳机 手机 iphone vivo oppo 小米 华为 单反 装机 图拉丁

360图书馆 购物 三丰科技 阅读网 日历 万年历 2024年12日历 -2024/12/23 13:56:37-

图片自动播放器
↓图片自动播放器↓
TxT小说阅读器
↓语音阅读,小说下载,古典文学↓
一键清除垃圾
↓轻轻一点,清除系统垃圾↓
图片批量下载器
↓批量下载图片,美女图库↓
  网站联系: qq:121756557 email:121756557@qq.com  IT数码
数据统计