IntelliJ IDEA 2022 类和方法注释模板设置

2024-05-06 13:10:43

一、概述

IDEA自带的注释模板一般都很简单，然而我们在写代码的时候喜欢把类注释和文档注释写在代码里，既方便自己看所有的参数，也便于以后维护代码的时候看到编码作者。下面是我的代码注释，我们就按照这种格式来设置：

二、类注释模板

File–>settings–>Editor–>File and Code Templates–>Files
文件->设置->编辑器->文件和代码模板->文件
插入备注信息到public上方

/**
* 类名称：${NAME}
* 描述:
* 创建人：XXX
* 创建时间：${DATE} ${TIME}
*/

三、方法注释模板

1、创建模板
IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，我们的习惯是 /*+Enter，这里我们也按照这种习惯来设置IDEA的方法注释

File–>Settings–>Editor–>Live Templates
文件->设置->编辑器->实时模板
新建组

2、设置模板内容-IDEA格式模板

*** 方法名称：* 方法描述：* 创建人：XXX** $params$* @return $return$*/

3、编辑右侧变量

groovyScript("if(\"${_1}\".length() == 2) {return '';}  else { def result='';  def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); for(i = 0; i < params.size(); i++) { if(i==0){result+='@param ' + params[i] + ' '} else{result+='\\n' + ' * @param ' + params[i] + ' '}};  return result;}", methodParameters() );

4、设置模板应用场景
点击模板页面最下方的警告，来设置将模板应用于那些场景，一般选择EveryWhere–>Java即可

（如果曾经修改过，则显示为change而不是define）

其实我后来放弃这么搞了，明明插件就可以搞定的问题，弄这么复杂，直接用easy javadoc插件就可以了，比这个强大，还能自动翻译

IntelliJ IDEA 2022 类和方法注释模板设置相关推荐

IDEA类和方法注释模板设置（非常详细、实用）
点个赞,看一看,好习惯!本文 GitHub https://github.com/OUYANGSIHAI/JavaInterview 已收录,这是我花了 3 个月总结的一线大厂 Java 面试总结,本 ...
IDEA类和方法注释模板设置
这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置: 类注释模板: /**** @ClassName: TestType* @Descriptio ...
IDEA方法注释模板设置
IDEA类和方法注释模板设置 1.File–>Settings–>Editor–>Live Templates (1)新建组:命名为userDefine (2)新建模板:选中你刚才创 ...
idea方法注释模板设置完了，不显示
idea方法注释模板设置完成之后,写了一个方法,但是上面的注释没有自动生成, 此时在方法上面另起一行, 输入 add(输入add字母就行),然后按下tab键,注释就自动生成了.
IntelliJ IDEA类和方法注释模板配置
1.设置文件注释设置Java类的注释模板,创建Java类自动生成该注释模板. 先看文件注释效果: 1.1.选择 IntelliJ IDEA -> 选择 Preferences... 打开IDE ...
idea设置Java类和方法注释模板
1.创建类/接口时,自动生成注释模板按照步骤(mac版本):IntelliJ IDEA->Preferences->Editor->File and Code Templates- ...
IDEA设置类、方法注释模板
类注释模板 File -> Other Setting -> Default Setting打开默认设置 Editor -> File and Code Templates -> ...
Idea 设置类、方法注释模板(解决params和return显示问题)---不来虚的实测有效
目录 1.使用场景 2.操作步骤 2.1.新建类模板注释添加 2.2.给类的方法生成方法注释 3.成果展现 4.参考文章 1.使用场景我们在开发项目的时候需要知道类的创建者,什么时间创建,这个类是什 ...
IDEA类和方法注释模板
先看效果类创建类的时候先描述这个类干啥用的方法先说创建类的注释模板选择class 类注释模板 /** * * @description ${description}* @date ${DAT ...

最新文章

热门文章