程序员经验分享-hwhale

如何在 IntelliJ IDEA 中快速生成 JavaDoc 注释模板

2023-05-16

笔者的工作环境：

  • IntelliJ IDEA 2021.2.2 (Ultimate Edition)

  • JDK 17

  使用 IntelliJ IDEA 中的实时模块可以快速生成 JavaDoc 注释。方法如下：（IntelliJ IDEA 在 2021 年之后的版本已经以插件的形式给出了 IntelliJ IDEA 的官方汉化版。该插件名为：Chinese (Simplified) Language Pack。因此本博客中 IntelliJ IDEA 的界面为中文版界面。）

  1. 按下图所示点击。

    在这里插入图片描述

  2. 创建一个 模块组，模块组 的名称可以任意起，只要不与已有的重复即可。

    在这里插入图片描述

    在这里插入图片描述

  3. 在模块组下添加一个 动态模板。

    在这里插入图片描述

  4. 选择此模板的生效场合。

    在这里插入图片描述

    在这里插入图片描述

  5. 设置此动态模板的 缩写、快捷键 和 模块文本。笔者在本教程中使用的 模块文本 如下：

    /**
 *
 *
 * @param
 * @return
 * @throws
 *
 * @implSpec
 * @apiNote
 * @implNote
 *
 * @since
 */

    【原理】

      此动态模板的原理是，如果设置了上述动态模板的 缩写、快捷键 和 模块文本，当依次输入 缩写、快捷键 时，输入的 缩写 就会自动被替换成 模块文本 中的内容。

    在这里插入图片描述

  6. 由于笔者前面设置的 缩写 为 /，快捷键 为 Tab。因此笔者只需要在代码中依次输入 /、Tab 之后，就可以立即生成前面设置的 JavaDoc 了。

    在这里插入图片描述

  7. 还可以变得更方便。由于符号 / 在中文模式下输入后会变成 、，切换中英文稍有不便。如果同时也将 、 设置为 缩写，那么就无需切换中英文了。

    在这里插入图片描述

    在这里插入图片描述

  8. 现在，依次输入 、、Tab 之后，也可以立即生成前面设置的 JavaDoc 了。

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

如何在 IntelliJ IDEA 中快速生成 JavaDoc 注释模板 的相关文章

随机推荐

  • ubuntn14.04 版本内核更换详细步骤

    Ubuntu14 04 版本 xff0c 内核为 3 13 XX 更换为 3 2 66 的方法 首先 xff0c 3 2 66第二个数字为偶数 xff0c 就是稳定版 xff08 现在是不是不拿这个区分了 xff1f 没搞清 xff0c 但

  • 设计模式_spring框架中常用的8种设计模式

    spring框架中常用到的8种设计模式清单如下 xff1a 设计模式 使用地方 备注 工厂模式 BeanFactory ApplicationContext 单例模式 Spring中的Bean 代理模式 Spring AOP java反射实

  • eclipse 部署与开发 cas 6.3

    安装前 xff0c 需要准备eclipse xff0c tomcat9 xff0c jdk11安装 eclipse安装gradle插件 打开eclipse xff0c 选择help eclipse market place 搜索builds

  • 2011研发工作总结

    转眼这一年又将过去 xff0c 伴随着公司的成立 xff0c 我们辛苦而又忙碌的从年头走到了年尾 以下是总结下这一年中工作的情况 xff0c 谈谈经验感想 xff0c 说说得失 公司成立 2011年刚开始 xff0c 公司就成立了 我们在喜

  • 论文笔记——EXPLAINING AND HARNESSING ADVERSARIAL EXAMPLES（解释和利用对抗样本）

    本文参考了三篇笔记 xff0c 帮助很大 xff1a Explaining and Harnessing Adversarial Examples 阅读笔记 论文笔记 Explaining amp Harnessing Adversaria

  • C++验证哥德巴赫猜想

    include lt iostream gt using namespace std bool Prime int i 判断是否为质数的函数 int j if i lt 61 1 return 0 如果小于等于1返回0 if i 61 61

  • 能ping通Linux 但是ssh连不上问题…

    问题 xff1a 能ping通Linux服务器 但是ssh连不上 lt Linux redhat AS4 版本 gt 解决方法这个问题花了我20分钟去查资料 xff0c 网上写的解决方法也是五花八门 xff0c 不过 xff0c 总算解决了

  • RuntimeError: NCCL error in:torch/lib/c10d/ProcessGroupNCCL.cpp:514, invalid usage, NCCL version 踩坑

    运行pytorch分布式任务时 xff0c 可能在执行dist barrier 这条代码时会触发NCCL错误 xff1a RuntimeError NCCL error in torch lib c10d ProcessGroupNCCL

  • 有一种服务称为MaaS

    Metal as a Service 有一种服务称为MaaS xff08 开源 xff09 xff1a 云管理平台中必不可少的服务 为服务对象提供裸机 xff08 1或n xff09 xff0c 服务对象可以用来安装云OS和其他云功能 使用

  • UDP网络编程服务器与客户端代码

    一 xff0c 通信模型 服务器 xff1a 1 创建socket xff0c 使用socket函数 2 准备通信地址 xff0c 使用结构体类型 3 绑定socket和通信地址 xff0c 使用bind函数 4 监听 xff0c 使用li

  • SAMBA共享工具安装

    1 xff0c 环境win7 b4位 xff0c ubuntu16 04 xff0c 确定ubuntu已连接到互联网 xff0c 执行如下命令下载 Samba 工具 xff1a sudo apt get install samba samb

  • K8s ❉ node节点未找到cni0/flannel.1网络

    问题描述 xff1a 现有测试环境有3台k8s服务器 xff0c 现在新添加两台服务器 xff0c 发现新加的服务器flannel 1和cni0网卡没有生成 root 64 slave1 ifconfig docker0 flags 61

  • 学习一下freertos streambuffer

    学习一下freertos stream buffer 最近在自己从0到1写rtos xff0c 主要是为了学习rtos xff0c 并没有其他卵用 xff0c 光学会调API是不够的 xff0c 看源码又恼火 xff0c 所以学习的最好办法

  • Writable接口

    在org apache hadoop io中 xff0c hadoop使用自己的序列化格式Writables接口 xff0c 具有紧凑 xff0c 快速的特点 xff0c 不过目前只有用Java才能较容易扩展 在hadoop中 xff0c

  • 解决数据库连接慢问题

    解决数据库连接慢问题方法 xff1a 方法一 连接数据库时 xff0c 使用localhost xff0c 不要使用明确的IP地址 xff08 远程数据库除外 xff09 xff1b 方法二 在my cnf配置文件里 xff0c 添加ski

  • 难忘的2011

    前言 xff1a 这些年 xff0c 每到年终之时 xff0c 我都会写个总结 2009年的 优化生活 规划未来 记录了一位初级网络优化工程师09年的所想与所做以及对10年的规划与展望 xff1b 2010年的 今天的2010 xff0c

  • QT从字体名获取字库文件路径(从宋体获取到simsun.ttc)

    MFC版本的从字体名获取字库文件路径点击此处 最近弄的一份项目需要裁剪ttf字库 xff0c 故需要用到此功能 xff01 用了几年QT xff0c 个人感觉类库是非常强大的 xff01 QT相比VS的话亮点在开源的类库非常的丰富 xff0

  • C++编写分形问题

    目的 xff1a 递归是基本的算法思想和设计方法之一 xff0c 也是数据结构重点讲授的部分 xff0c 是许多算法的基础 xff0c 对它们的理解和运用直接关系着其他算法的理解和应用 因此 xff0c 熟练掌握递归是十分重要的 通过本题

  • MFC从字体名获取字库文件路径(从宋体获取到simsun.ttc)

    上一篇有讲到在QT中从字体名获取文字的路径 xff0c 这个是MFC版本的 xff1a QT从字体名获取字库文件路径 include lt string gt using namespace std void wcharTochar con

  • 如何在 IntelliJ IDEA 中快速生成 JavaDoc 注释模板

    笔者的工作环境 xff1a IntelliJ IDEA 2021 2 2 Ultimate Edition JDK 17 使用 IntelliJ IDEA 中的实时模块可以快速生成 JavaDoc 注释 方法如下 xff1a xff08 I

热门标签