IDEA类和方法的注释模版

月牙坠

已于 2023-11-12 17:43:15 修改

阅读量121

点赞数

分类专栏：工具文章标签： intellij-idea java

于 2023-04-29 10:08:40 首次发布

本文链接：https://blog.csdn.net/qq_45594962/article/details/130438404

版权

工具专栏收录该内容

4 篇文章 0 订阅

订阅专栏

该文章展示了一个Java控制器类HelloController的代码，包含两个方法：index()和hello()。hello()方法使用Hutool库的StrUtil.format方法处理字符串。类和方法都配有详细的JavaDoc注释。

摘要由CSDN通过智能技术生成

效果

package top.yueyazhui.formlogin.controller;

import cn.hutool.core.util.StrUtil;

/**
 * @description todo
 * @author yueyazhui
 * @website yueyazhui.top
 * @email yueyazhui@sina.com
 * @date 2023-04-24 23:42
 **/
public class HelloController {

    /**
     * @description todo
     * @author yueyazhui
     * @website yueyazhui.top
     * @email yueyazhui@sina.com
     * @date 2023-04-24 23:43
     **/
    public void index() {

    }

    /**
     * @description todo
     * @author yueyazhui
     * @website yueyazhui.top
     * @email yueyazhui@sina.com
     * @date 2023-04-24 23:50
     * @param name
     * @return
     **/
    public String hello(String name) throws Exception {
        return StrUtil.format("Hello {}", name);
    }
}

类
在这里插入图片描述

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")


/**
 * @description todo
 * @author yueyazhui
 * @website yueyazhui.top
 * @email yueyazhui@sina.com
 * @date ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 **/
public class ${NAME} {
}

方法
在这里插入图片描述

*
 * @description $todo$
 * @author yueyazhui
 * @website yueyazhui.top
 * @email yueyazhui@sina.com
 * @date $date$ $time$$param$$return$
 **/

// @date
groovyScript("def list = \"${_1}\".split('/').toList(); def year = list[0]; def month = list[1].length() == 1 ? '0' + list[1] : '' + list[1]; def day = list[2].length() == 1 ? '0' + list[2] : '' + list[2]; return year + '-' + month + '-' + day", date())

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

// @return
groovyScript("return \"${_1}\" == 'void' ? null : '\\r\\n * @return '", methodReturnType())

防止代码格式化时打乱 JavaDoc 的顺序
在这里插入图片描述