如何使用Intellij Idea生成JavaDoc文档

2023-11-11

JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。

先看一段样例代码:

//: POI/ExportConfig
/** Excel导出项配置
 * @author Mr zhang
 * @version 1.0
 * @since 1.8
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.FIELD })
public @interface ExportConfig {

	/**
	 * @return 表头显示名(如:id字段显示为"编号") 默认为字段名
	 */
	String value() default "field";

	/**
	 * @return 单元格宽度 默认-1(自动计算列宽)
	 */
	short width() default -1;

	/**
	 * 将单元格值进行转换后再导出:<br/>
	 * 目前支持以下几种场景:<br/>
	 * 1. 固定的数值转换为字符串值(如:1代表男,2代表女)<br/>
	 * <b>表达式:</b> "s:1=男,2=女"<br/>
	 * 
	 * 2. 数值对应的值需要查询数据库才能进行映射(实现com.haohuo.util.poi.convert.ExportConvert接口)<br/>
	 * 
	 * @return 默认不启用
	 */
	String convert() default "";

	/**
	 * @return 当前单元格的字体颜色 (默认 HSSFColor.BLACK.index)
	 */
	short color() default HSSFColor.BLACK.index;

	/**
	 * 将单元格的值替换为当前配置的值:<br/>
	 * 应用场景: <br/>
	 * 密码字段导出为:"******"
	 * 
	 * @return 默认true
	 */
	String replace() default "";
}///:~  
稍微说一下常用的注解及其作用:

首先规则:以//: 开始,以///:~结束。

  • @author 作者名

  • @version 版本号

  • @since 指明需要最早使用的jdk版本

当然还有一些其他注解,例如在类的方法上:

  • @param 参数名

  • @return 返回值情况

  • @throws 异常抛出情况

看IDEA如何配置后生成javadoc文档
  • one
    在这里插入图片描述
  • two
    在这里插入图片描述
    解释一哈:
  1. 选择是整个项目还是模块还是单个文件

  2. 文档输出路径

  3. Locale 选择地区,这个决定了文档的语言,中文就是zh_CN

  4. 传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8 -windowtitle “文档HTML页面标签的标题” -link http://docs.Oracle.com/javase/7/docs/api

可以看到控制台的输出:
在这里插入图片描述

然后找到生成的html:
在这里插入图片描述
看一下效果:
在这里插入图片描述

小功告成

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何使用Intellij Idea生成JavaDoc文档 的相关文章

随机推荐

  • shared_ptr在Qt项目中使用,慎重

    偶然查到到了一个崩溃 记录一下 一个继承自QObject的自定义类 里面有什么并不重要 class TestProcess public QObject Q OBJECT 摘取了部分实现 眼尖的大佬不妨看下 下面的代码是不是有问题 shar
  • java初学(九)给定一个排序数组和一个目标值,在数组中找到目标值,并返回其索引。如果目标值不存在于数组中,返回它将会被按顺序插入的位置。

    给定一个排序数组和一个目标值 在数组中找到目标值 并返回其索引 如果目标值不存在于数组中 返回它将会被按顺序插入的位置 你可以假设数组中无重复元素 示例 1 输入 1 3 5 6 5 输出 2 示例 2 输入 1 3 5 6 2 输出 1
  • 使用WebContext.Items 存储Linq to sql 的DataContext实例引发"InvalidCastException"错误

    为了保证在一次请求过程中 使用同一个DataContext实例 我们项目使用WebContext items 来存储这个实例 最近不知道怎么回事 总是偶然性的抛出下面这个类型转换失败错误 百思不得其解 最后在MSDN的一个帖子里找到一种解释
  • 如何获取li标签中的值

    前言 最近在做动态添加表单 管理员从后台添加了菜单 一般用户登录 可以看到管理员新添加的菜单 和菜单中的属性 但是问题来了 动态添加完了 到展示给一般用户的页面 现在能想到的就是for循环出来的 但是要去到for循环出来的li标签的值怎么取
  • 机器视觉毕业设计 深度学习人脸识别系统设计与实现 - opencv python

    文章目录 0 前言 1 机器学习 人脸识别过程 人脸检测 人脸对其 人脸特征向量化 人脸识别 2 深度学习 人脸识别过程 人脸检测 人脸识别 Metric Larning 0 前言 这两年开始毕业设计和毕业答辩的要求和难度不断提升 传统的毕
  • SpringBoot项目引入token设置

    一 先了解熟悉JWT JSON Web Token 看这些介绍 结构之类的 确实挺无聊的 想直接进入主题的话 就跳过第一大步 望各位同仁给出相关意见 以备我来更加深入的学习 1 JSON Web Token是什么鬼 这个东西 反正理解成一个
  • Ubuntu安装ftp

    1 安装 sudo apt install vsftpd 2 添加一个用户 sudo adduser ftp zhang 然后输入密码Zhang 520 之后会自动在 home 创建ftp zhang目录 3 修改配置文件 sudo vi
  • Python循环语句简单练习题及答案解析

    1 这里的问题是猜出电脑里存储的数字是什么 你将要编写一个能够随机生成一个0到100之间且包括0和100的数字的程序 这个程序提示用户连续地输入数字直到它与那个随机生成的数字相同 对于每个用户输人的数字 程序会提示它是否过高还是过低 所以
  • 7、寻找最好成绩

    问题描述 建立一个对象数组 内放若干个学生的学习数据 学号 成绩 设计一函数max 使用学生对象数组作为参数 在max函数里找出这些学生中成绩最高者 并输出其学号及成绩 在main函数中使用并测试之 在main函数中读入学生数据 创建学生对
  • UpLoad-labs靶场通关笔记

    目录 UpLoad labs靶场通关 运行环境 Pass 01 Pass 02 Pass 03 Pass 04 Pass 05 Pass 06 Pass 07 Pass 08 Pass 09 Pass 10 Pass 11 Pass 12
  • php api接口 致命错误,条纹 - 致命错误 - 未提供API密钥 - PHP

    提交charge php条带支付页面时 我一直收到以下错误 我也没有使用作曲家 我不确定为什么会发生这种错误 致命错误 未捕获异常 Stripe Error Authentication 并显示消息 未提供API密钥 提示 使用 Strip
  • 数据结构初识

    一 初识数据结构 1 什么是数据结构 2 什么是是算法 3 数据结构和算法的重要性 4 如何学好数据结构和算法 5 数据结构和算法的拓展阅读推荐 1 什么是数据结构 数据结构是计算机存储 组织数据的方式 指相互之间存在一种或多种特定关系的数
  • jquery循环语句if-else if-else

    jquery循环语句if else if else callbackFun 函数 开始是写的if if else 结果是不管第一个if有没有匹配到 会再次判断 如果匹配到第二个if 则第二个if中的语句执行 没有匹配到第二个if 则else
  • Unable to connect to Command Metric Stream 'api/turbine/stream?cluster=REPORTS' Error: {"isTrusted"}

    Spring Boot Admin 整合Hystrix UI Module Turbine UI Module 报如下错误 首先确保你的admin server引入了一下的依赖
  • Nginx配置文件详解

    Nginx配置文件 Nginx的核心配置文件默认是放在 usr local nginx conf nginx conf worker processes 1 events worker connections 1024 http inclu
  • 阿里云Nas文件存储的各种场景使用

    文章目录 1 ECS服务器挂载NAS文件存储 1 1 添加NAS挂载点 1 2 为ECS挂载NAS存储 image 202202012230314501 3 验证ECS服务器是否挂载了NAS存储 1 4 卸载挂载的NAS存储 2 通过命令行
  • JAVA在linux上运行带包的class文件

    以Test java为例子 Test java的类路径为ut test Test java 1 新建ut目录 再新建test目录 把Test java拷贝到test目录下 2 cd 到该目录 运行javac Test java 3 然后cd
  • 总结:OSI七层协议

    一 OSI七层协议 每层运行常见设备 二 物理层 计算机之间需要用光缆 电缆 双绞线 无线电波等连接 完成组网 才能通讯 物理层功能 主要是基于电器特性发送高低电压 电信号 高电压对应 1 低电压对应 0 三 数据链路层 单纯的电信号 0
  • 常用DataSource配置

    先介绍配置dataSource的几种方式 1 org springframework jdbc datasource SimpleDriverDataSource 说明 SimpleDriverDataSource使用池化技术 推荐
  • 如何使用Intellij Idea生成JavaDoc文档

    JavaDoc是一种将注释生成HTML文档的技术 生成的HTML文档类似于Java的API 易读且清晰明了 在简略介绍JavaDoc写法之后 再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档 先看一段样例代码 PO