IDEA 设置文档注释

1、参考资料

IDEA类和方法注释模板设置（非常详细）
idea注释模版配置（吐血推荐！！！）

2、类文档注释

2.1、设置类文档注释模板

在【File and Code Templates】页面设置类（Class）的文档注释

/***@ClassName ${NAME}*@Description  TODO*@Author ${USER}*@Date ${DATE} ${TIME}*@Version 1.0*/

2.2、使用类文档注释

注意：只有新建类的时候，才能创建类的文档注释哦

3、设置接口文档注释

3.1、设置接口文档注释模板

同样的方法，在【File and Code Templates】页面设置接口（Interface）的文档注释

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/***@InterfaceName ${NAME}*@Description  TODO*@Author Oneby*@Date ${DATE} ${TIME}*@Version 1.0*/
public interface ${NAME} {
}

3.2、使用接口文档注释

注意：只有新建接口的时候，才能创建接口的文档注释哦

4、方法文档注释

4.1、设置方法文档注释模板

在【Live Templates】中新建一个模板
默认会新建一个名为 user 的分组（我也懒得改名字了）
1. Abbreviation：* 表示在方法上输入 *，再敲击 Enter 就能出现方法文档注释
2. Description：为方法添加文档注释
3. Template Text：模板内容
4. Applicable in Java：仅在 Java 文件中生效
为模板上的变量添加默认值

方法文档注释的模板

** * @description: $description$$params$* @return: $returns$* @author Oneby* @date: $date$ $time$*/

params 的 default value：

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

4.2、使用方法文档注释

Nice~~~

IDEA 设置文档注释相关推荐

eclipse设置文档注释的格式
eclipse设置文档注释的格式
PyCharm 设置文档注释
PyCharm 设置文档注释为了方便表示函数变量名.返回说明等说明信息,文档字符串格式设置.pycharm有内置注释模板. (这边使用的是已汉化的pycharm) 1.打开设置(setting) 2 ...
关于如何在idea中设置文档注释模板
java文档注释的模板设置
设置位置:在preference > java > code style > code templates > comments 中: 1.类的文档注释模板: /*** @au ...
eclipse注释模板_Intellij IDEA设置默认文档注释
idea开发环境配置一.类注释 File->setting Setting->File and Code Templates 我的文档注释模板: /*** @author: ${USER ...
Java文档注释 - IDEA设置
一. 概述 Java支持三种注释.前两种分别是单行注释 // 和多行注释 /* */ ,第三种是文档注释 /** */. 在IDEA中,文档注释可以对类.接口.方法.属性等进行描述,提高阅读效率 ...
IntelliJ IDEA2022中的Java文档注释设置、操作详述
1.打开IDEA,点击setting-Editor-Live Templates. 2.点击右方的"+"准备进行文档注释的内容和快捷键设置. 右键,选中 change contex ...
java学习笔记(四)----对象、数组作为参数传递，静态变量、静态方法的使用，内部类，使用文档注释
***对象作为参数传递*** class passparam { int x; public static void main(String[] args) { passparam obj = ...
Eclipse 的快捷键以及文档注释、多行注释的快捷键一、多行注释快捷键
一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/* */注释 3.以上快捷在重 ...

IDEA 设置文档注释

IDEA 设置文档注释

1、参考资料

2、类文档注释

2.1、设置类文档注释模板

2.2、使用类文档注释

3、设置接口文档注释

3.1、设置接口文档注释模板

3.2、使用接口文档注释

4、方法文档注释

4.1、设置方法文档注释模板

4.2、使用方法文档注释

IDEA 设置文档注释相关推荐

最新文章

热门文章