IntelliJ IDEA2022中的Java文档注释设置、操作详述

已于 2022-08-08 15:37:08 修改
阅读量2.6k 收藏 4
点赞数 2
分类专栏： 开发工具 文章标签： intellij-idea java
于 2022-08-08 15:30:57 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/blbyu/article/details/126226974
版权

1、打开IDEA，点击setting-Editor-Live Templates。

在这里插入图片描述

2、点击右方的“+”准备进行文档注释的内容和快捷键设置。

在这里插入图片描述

右键，选中 change context，勾选中Java。

在这里插入图片描述
在这里插入图片描述

3、自定义文档注释模板，在Abbreviation中输入模块名称，在Description中输入描述，在Template text中输入注释内容。

在这里插入图片描述
自定义的注释内容依次是描述、作者、日期、参数。

/**
 *@description：  
 *@author：$USER$
 *@date：$DATE$ $TIME$
 *@param：$param$
 */

4、在Options下的Expand with中设置触发快捷键。

在这里插入图片描述

5、点击Eidt variables，进行注释内容配置，配置如图所示，完成后点即OK和Apply即可。

在这里插入图片描述

6、IDEA的文档注释效果展示，输入/**，按下Enter即可展示之前配置好的文档注释。

在这里插入图片描述

IntelliJ IDEA快速入门 | 第二十八篇：详述IntelliJ IDEA（或者Eclipse）中一些常用的快捷键（下）
李阿昀的博客
03-31 903
由于IntelliJ IDEA（或者Eclipse）中常用的快捷键比较多，所以这里我就分两篇文章来给大家进行讲述了，这是第二篇。 F2：查看文档说明 如果咱们现在想查看一下System类的文档说明，那么该怎么办呢？其实，咱们之前在讲IntelliJ IDEA中的常用配置时，就做过这样一个设置，即当把光标放到某个类上以后，1秒种之后显示出该类的一个文档说明。设置了还好，要是我们没有这样设置呢，那也没有关系，我们可以把光标放在某个类上，然后再按下F2键，这时马上就会显示出该类的一个文档说明了，而不是在1秒种以后
idea从零到精通03之idea快捷键详述
2401_84097883的博客
04-19 997
在print方法处，按下快捷键 Ctrl + U后。在26行Test1处，按下Ctrl + B后跳转到Test1类查看Test1类的定义，窗口方式本人分享一下这次字节跳动、美团、头条等大厂的面试真题涉及到的知识点，以及我个人的学习方法、学习路线等，当然也整理了一些学习文档资料出来是附赠给大家的。知识点涉及比较全面，包括但不限于前端基础，HTML，CSS，JavaScript，Vue，ES6，HTTP，浏览器，算法等等详细大厂面试题答案、学习笔记、学习视频等资料领取，点击资料领取直通车免费领取！
IDEA配置统一 java 类注释
01-30
java类注释~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Java文档注释 - IDEA设置
czc_292的博客
01-06 2601
一. 概述 Java支持三种注释。前两种分别是 单行注释 // 和 多行注释 /* */ ，第三种是 文档注释 /** */。 在IDEA中，文档注释可以对类、接口、方法、属性等进行描述，提高阅读效率。 文档注释只能写在类、接口、方法、属性等前面，否则无效。 二. 类注释 1. File -> Settings 2. Editor -> File and Code Templates -> Includes -> File Header 右侧写文档注释模板
idea中快速注释函数
最新发布
weixin_42220130的博客
03-24 1545
如果你想自定义注释的格式，可以通过以下步骤设置自定义的Live Template[4打开系统设置（Setting），使用快捷键Ctrl+Alt+S。在设置窗口中，导航到Editor->。点击号，添加一个新的模板组来放置自定义的快捷键模板。选中创建的组，再次点击号，添加一个新的Live Template。设置自定义的快捷键模板，包括Abbreviation（快捷键）、Description（描述）、Template text（自定义模板内容）。
IDEA（Java注释）
2302_79884878的博客
03-12 807
注释有三种:单行注释（//），多行注释（/**/），文件注释(与多行注释相似，首位行相同，其余每行都有星号)
IDEA java 代码注释的一些设置
thhhhhhhhhhhhhh的博客
06-10 835
java编译器IDEA，如何优雅设置注释的一些配置
idea java 注释模板_idea java 注释模板配置
weixin_33037089的博客
02-15 901
在网上找了好久，好多的文章都有一个共同的病点就是“@param注释当有多个参数时候，全部放在了一行里面”，非常不友好。以下是我整理好的，完全按照eclipse的注释风格。！！！先看最后实现的效果图，如下：(eclipse代码的“作者”、“时间”放在同一行，idea分开两行，这个不影响，可以自行调整。) -------------------------------------------...
呕心沥血整理出的史上最简单的IntelliJ IDEA教程，快来看哟！
李阿昀的博客
04-15 2231
前言 IntelliJ IDEA（简称IDEA），是Java语言开发的集成环境，IDEA在业界被公认为是最好的Java开发工具之一，尤其在智能代码助手、代码自动提示、重构、J2EE支持、各类版本工具（Git、SVN、GitHub等）、JUnit、CVS整合、代码分析和创新的GUI设计等方面的功能都值得称道。 之前，笔者一直在用Eclipse做Java后台的开发，现在是时候该拥抱IntelliJ IDEA了，不然就太out了。因此，撰写本系列文章的目的也很简单，就是想把自己的经验整理记录下来，当然，如果能够在
字节工程师自研基于 IntelliJ 的终极文档套件
字节跳动技术团队官方博客
01-18 3487
前言众所周知，程序员最讨厌的四件事：写注释、写文档、别人不写注释、别人不写文档。因此，想办法降低文档的编写和维护成本是很有必要的。当前写技术文档的模式如图：痛点总结有如下三方面：针对上述问...
AWS Java SDK S3 中文对照手册与开发指南
资源摘要信息:"本资源包名称为【aws-java-sdk-s3-1.12.367.jar中文-英文对照文档.zip】，是一份针对Amazon Web Services（AWS）提供的Java Software Development Kit（SDK）中针对Simple Storage Service（S3）的...
详解IDEA自定义注释模板(javadoc)
08-27
主要介绍了详解IDEA自定义注释模板(javadoc)，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
【idea】设置Java 类、方法的注释模板
一夜飘零
11-16 1722
1、打开File-> Settinhs->Editor选择File and Code Templates2、选择Files下面的Class 如下图所示3、注意勾选 Enable Live Templates。
IDEA中Java类和方法注释
悟能的师兄的专栏
11-12 5631
一：类注释 File-->Settings-->Editor-->File and CodeTemplates /** * Created with IntelliJ IDEA. * Copyright@ Apache Open Source Organization * @Auther: Apache * @Date: ${YEAR}/${MONTH}/${D...
idea java注释
北粥的博客
08-12 120
注释 不会执行，写给写代码的人看，写复杂多了还能看懂的保障。 注释类型(三种) 单行// 多行/* */ 文档/** */
idea中Java的三种注释
menghuanx的博客
03-27 708
idea中java的三种注释 单行注释：// 般用于注释少量的代码或者对附近的代码进行说明 多行注释: /* / 多用于注释多行代码 文档注释: /* */ 一般用于对类和方法进行说明 三种注释方法的快捷键： 单行注释：选中区域+alt+/ 取消注释同样是这个快捷键 多行注释：选中区域+Ctrl+shift+/ 取消注释一样 文档注释：/**+回车 ...
【注释模板】IDEA中JAVA类、方法注释模板教程
weixin_44718672的博客
05-08 7000
为了方便、系统化IDEA开发者对于创建JAVA类、方法等注释的编写，今天为读者们介绍如何设置并利用模板实现高效开发，快速迭代。
如何在IDEA设置Java类和方法的注释模板？
weixin_44318460的博客
07-26 3125
首先我们打开IDEA软件，进行如下操作File–>Settings–>Editor–>FileandCodeTemplates。首先我们打开IDEA软件，进行如下操作File–>Settings–>Editor–>LiveTemplates。设置好后，当我们再次创建新的代码文件时，就会自动显示类的注释模板了。ctrl+alt+v自动生成左边内容。ctrl+alt+L格式化代码块。ctrl+q查看类，方法，属性。......
在IDEA编写Java代码的程序注释
ughbnbjkk的博客
07-05 674
如何在代码中添加注释,并且生成JavaDoc文档
java文档注释
03-17
### Java 文档注释的编写方式 Java 的文档注释是一种特殊的注释形式，用于描述类、接口、方法以及字段等内容。这些注释可以通过 JDK 自带的 Javadoc 工具提取出来，生成结构化的 API 文档。 #### 1. 文档注释的基本格式 文档注释以 `/**` 开始，并以 `*/` 结束[^3]。它通常位于被注释的内容之前，例如类、方法或变量前。以下是基本语法： ```java /** * 这里是文档注释的内容。 */ public class Example { public static void main(String[] args) { System.out.println("Hello, World!"); } } ``` #### 2. 常见标签及其用途 为了增强文档的功能性和可读性，可以在文档注释中使用特定的标签。常见的标签包括但不限于以下几种： - **@author**: 表明作者的名字。 - **@version**: 定义版本号。 - **@param**: 描述方法参数的意义。 - **@return**: 阐述方法返回值的信息。 - **@throws/@exception**: 指定可能抛出的异常类型及原因。 - **@see**: 提供额外的相关链接或参考信息。 下面是一个完整的例子，展示了如何利用上述标签来撰写详细的文档注释： ```java /** * This is a simple calculator that adds two integers. * * @author John Doe * @version 1.0 */ public class Calculator { /** * Adds two integer values and returns the result. * * @param num1 The first number to be added. * @param num2 The second number to be added. * @return The sum of num1 and num2. * @throws IllegalArgumentException If either input parameter is null or invalid. */ public int add(int num1, int num2) throws IllegalArgumentException { if (num1 < Integer.MIN_VALUE || num2 < Integer.MIN_VALUE) { throw new IllegalArgumentException("Input parameters cannot be less than minimum value."); } return num1 + num2; } /** * Prints out a greeting message with specified name. * * @param name Name of the person being greeted. */ public void greet(String name) { System.out.println("Hello, " + name); } } ``` #### 3. 使用 Javadoc 工具生成文档 一旦完成带有适当文档注释的源代码后，就可以借助 Javadoc 工具将其转换为 HTML 格式的帮助文档。具体操作步骤如下所示（基于命令行环境）[^2]： 假设有一个名为 `Calculator.java` 的文件，则可通过运行以下命令生成对应的文档： ```bash javadoc -d docs Calculator.java ``` 此命令会将生成的结果存储到当前目录下的 `docs` 文件夹中。 ---
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

慕斯-ing

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值