idea 自定义 javadoc

原创已于 2022-09-14 15:09:36 修改 · 2k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#java #intellij-idea #intellij idea #macos

于 2022-09-14 14:55:04 首次发布

IntellJ IDEA 专栏收录该内容

1 篇文章

订阅专栏

本文介绍了如何在IntelliJ IDEA中配置Class和Method的Javadoc模板，提供了一种简洁的自动添加作者、时间和描述的方式，方便开发者快速生成规范的Java文档注释。通过调整IDEA的Live Templates设置，可以自定义方法注释模板，提高编码效率。

1.idea版本

2.配置class javadoc

3.配置method javadoc

1.idea版本

macos :

idea :

2.配置class javadoc

参考配置：

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
/**
 * @author ${USER}
 * @time ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}:${SECOND}
 * @description TODO
 */
public class ${NAME} {
}

效果参考（创建文件后，自动添加如下javadoc）：

package com.sun.demo.web.pojo;

/**
 * @author sun
 * @time 2022-09-14 14:43:35
 * @description TODO
 */
public class DemoPojo {
}

3.配置method javadoc

注：其他博客中，都建议通过Live Templates自定义method javadoc，思路是创建自定义template，然后配置注释格式，然后配置触发快捷键，博主曾经使用过，感觉不如直接修改idea默认的method javadoc的格式。

如图配置idea 默认的 method javadoc 模板，即可在添加方法javadoc的时候，直接触发。

参考配置（只是在默认的格式上加了author，第一行是自定义加的，其他的都是默认的）：

 * @author ${USER}
#foreach($param in $PARAMS)
 * @param $param
#end
#if($RETURN_TYPE != "void")
 * @return
#end
#foreach($param in $TYPE_PARAMS)
 * @param <$param>
#end
#foreach($exception in $THROWS)
 * @throws $exception
#end

参考效果（通过默认的快捷键组合【/**+Enter】触发）：

    /**
     * 
     * @author sun
     * @param var1
     * @param var2
     * @param var3
     * @return
     * @throws Exception
     */
    public String test(String var1, String var2, int var3) throws Exception {
        
        return "test";
    }

参考：

Javadocs | IntelliJ IDEA