IDEA插件系列(3):Easy Javadoc插件——快速生成javadoc文档注释

article/2025/10/27 6:33:23

1.插件介绍

Easy Javadoc插件。

能帮助开发者快速生成类、方法、属性等中文javadoc
在这里插入图片描述

2.安装方式

第一种安装方式是在线下载安装插件。
在这里插入图片描述
第二种安装方式是使用离线插件进行安装。

插件下载地址:https://plugins.jetbrains.com/plugin/12977-easy-javadoc
在这里插入图片描述

3.使用方法

可以直接查阅官方的使用说明,是中文文档。

默认快捷键(可通过IDEA快捷键设置修改)

win
快捷键作用域说明
ctrl \类、方法、属性(光标放上面就行,不要双击选中!)生成当前文档注释
ctrl \选中的中文生成选中的中文的英文命名
ctrl \选中的非中文弹框展示翻译结果
ctrl shift \生成全部文档注释
mac
快捷键作用域说明
command \类、方法、属性(光标放上面就行,不要双击选中!)生成当前文档注释
command \选中的中文生成选中的中文的英文命名
command \选中的非中文弹框展示翻译结果
command shift \生成全部文档注释

注意,需要将光标放在方法名、变量名、类名的字符串中间(不要选中,因为选中会变成编译该单词)再按快捷键才会生效。如下图:
在这里插入图片描述
可以对文档注释中的作者名、日期格式等进行相关设置,还可以设置翻译媒介(如百度翻译、有道翻译等)。
在这里插入图片描述
类注释模版

/*** 类名称:$CLASSNAME$** 描述:$DOC$* 创建人: $AUTHOR$ * 创建时间: $DATE$
*/

在这里插入图片描述

方法注释模版

/*** $DOC$** $PARAMS$ * $RETURN$* @author $AUTHOR$ * @date $DATE$
*/

在这里插入图片描述
如果它们的快捷键发生冲突,可以在Keymap(按键映射)面板中进行修改。
在这里插入图片描述


http://chatgpt.dhexx.cn/article/XaeGWBql.shtml

相关文章

javadoc简介及用法

注释文档 文档和代码分离,在每次修改代码的时候,就需要修改相应的文档,解决的方法是将代码同文档“链接”起来,简单的方法是将所有东西放在同一文件。实现这一目的必须使用特殊的注释语法标记文档,此外需要工具提取注…

用IDEA生成JAVADoc

用IDEA生成JAVADoc 1.在IDEA工具栏tools中,打开选项Generate JavaDoc(生成javaDoc 文件) 2.配置参数 1.选择生成JavaDoc文档的范围 2.输出目录自己专门设置一个文件夹,方便后期查阅 3.区域设置,决定文档的语言,简体中文就是zh_CN…

Java基础:生成JavaDoc文档的方法

Java Doc javadoc命令是用来生成自己API文档的 参数信息 author 作者名 version 版本号 since 指明需要最早使用的jdk版本 param 参数名 return 返回值情况 throws 异常抛出情况 一、用命令行生成JavaDoc 1.在IDEA选择选择要操作的类 2.在上方的导航栏里输出cmd 调出命令行窗…

Javadoc到底是什么??

Javadoc到底是什么?? Javadoc的定义 javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完…

Java.Doc

java.doc命令是用来生成自己APL文档的 参数信息 author 作者名version 版本号since 指明需要最早使用的jdk版本param 参数名return 返回值情况throws 异常抛出情况 新建一个class 这一个注释是在类上面的 接下来跟着打 这是一个名字 这个名字需要参数 再注释时,自…

Java文档注释用法+JavaDoc的使用详解

Java文档注释JavaDoc的使用详解 简介 文档注释负责描述类、接口、方法、构造器、成员属性。可以被JDK提供的工具 javadoc 所解析,自动生成一套以网页文件形式体现该程序说明文档的注释。 注意:文档注释必须写在类、接口、方法、构造器、成员字段前面&…

Java教程:Javadoc(文档注释)详解

本篇文章由 泉州SEO www.234yp.com 整理发布,Java教程 www.234yp.com/Article/198092.html 谢谢合作!Java教程Java 支持 3 种注释,分别是单行注释、多行注释和文档注释。文档注释以/**开头,并以*/结束,可以通过 Javado…

Javadoc (Java API 文档生成器)详解 [Javadoc 概述][Javadoc 标签][Javadoc 命令][Javadoc 生成 API 文档]

您的“关注”和“点赞”,是认可,是支持,是动力。 如意见相佐,可留言。 本人必将竭尽全力试图做到准确和全面,终其一生进行修改补充更新。 本文首发在IT羊资源网。 《IT羊资源网》,网址:https://…

Javadoc 使用详解

分享一个朋友的人工智能教程(请以“右键”->"在新标签页中打开连接”的方式访问)。比较通俗易懂,风趣幽默,感兴趣的朋友可以去看看。 很多程序对Javadoc都不重视,认识不到Javadoc的作用,很多人都是这样认为的:…

IntelliJ IDEA开发工具安装教程(2022.2最新版)

IntelliJ IDEA开发工具安装教程(2022.2最新版) 下载官网网址: https://www.jetbrains.com/idea/ 一、下载安装: 1, 打开官网下载IntelliJ IDEA,刚打开网站是这样的。点击Download 2. 左边Ultimate是旗舰…

Java小白必会!Intellij IDEA安装、配置及使用详细教程

作者:孙玉昌,昵称【一一哥】,另外【壹壹哥】也是我哦 千锋教育高级教研员、CSDN博客专家、万粉博主、阿里云专家博主、掘金优质作者 配套开源项目资料 Github: GitHub - SunLtd/LearnJava Gitee: 一一哥/从零开始学Jav…

IDEA安装及使用教程

提示:文章写完后,目录可以自动生成,如何生成可参考右边的帮助文档 文章目录 IDEA的下载及安装教程一、IDEA的下载二、安装教程1、安装2.运行IDEA 以上就是IDEA的安装及配置啦!!! IDEA的下载及安装教程 提示…

IntelliJ IDEA下载安装配置教程(完全)

1 百度搜索idea 2 点击进入 3 选择旗舰版下载 4 点击安装 5 安装 6 激活 点击桌面图标后,接受什么的,点击LICENSE SERVER,(忘了截图,原谅我), 输入http://idea.congm.in 点击active即可。 7 配置(很重要&…

IDEA 下载安装教程

IntelliJ IDEA 简称 IDEA,由 JetBrains 公司开发,功能很强大 1.首先打开IntelliJ IDEA 官网(官网地址为 IntelliJ IDEA: The Capable & Ergonomic Java IDE by JetBrains) 2.打开下载好的文件,Next 3. 安装路径一…

JAVA intellij idea社区版安装教程

文章目录 JAVA intellij idea社区版安装教程下载 intellij idea 编写HelloWorld修改字体修改编程背景 JAVA intellij idea社区版安装教程 下载 intellij idea 下载链接 一、下载社区版 二、点击next 三、选择自己下载的路径 四、推荐勾选 五、安装 六、耐心等待 七、完成 八…

IntelliJ IDEA 2023安装教程【Windows系统】

目录 一、确认JDK 二、安装IntelliJ IDEA 三、测试环境 四、实用插件安装 一、确认JDK 1、打开命令提示符,输入如下命令查看是否有JDK java -version 2、如果没有的话请参考这篇文章的第一节 安装JDK 二、安装IntelliJ IDEA 1、进入官网,选择操作…

IntelliJ IDEA安装操作步骤

一、下载安装 1、打开官网:http://www.jetbrains.com/idea/,点击页面中的“DOWNLOAD” 2、根据自己的需要选择下载的IntelliJ IDEA版本,此处我的电脑是Windows7 64 位的,我选择的是Community(社区版) 3、…

IntelliJ IDEA安装图文教程

IntelliJ IDEA 是 java语言开发的集成环境,在业界被公认为最好的 java开发工具之一,尤其在智能代码助手、代码自动提示、重构、J2EE支持、各类版本工具(git、svn等)、JUnit、CVS整合、代码分析、 创新的 GUI设计等方面的功能可以说…

Intellij IDEA 安装配置(超详细)

【1】点击进入 IDEA 官网 点击直接进入下载页面: https://www.jetbrains.com/zh-cn/idea/download/other.html官方下载网址https://www.jetbrains.com/idea/ 新手可以点击右上角【文/A】选择中文模式 对于像我一样的新手选择Community(社区版)下的2021.3.3-windows(…

如何安装 IntelliJ IDEA 最新版本——详细教程

IntelliJ IDEA 简称 IDEA,被业界公认为最好的 Java 集成开发工具,尤其在智能代码助手、代码自动提示、代码重构、代码版本管理(Git、SVN、Maven)、单元测试、代码分析等方面有着亮眼的发挥。IDEA 产于捷克,开发人员以严谨著称的东欧程序员为主…