Idea配置java文件注释

配置java文件头注释

步骤：file -> setting -> Editor -> File and Code Templates -> Includes -> File Header ，加入以下代码

/**
 * 描述
 * @author ${USER}
 * @date ${DATE} ${TIME}
 */

配置代码片段

• 步骤：file -> setting -> Live Templates -> -> 右侧点击 + -> Template Group… ，输入：UserTemplates
• by default expand with：Tab

文件头注释

步骤：选中UserTemplates -> 右侧点击 + Live Template
Abbreviation：jc
Description：java文件注释
Define：选择java
Template text：

/**
 * 描述
 * @author $user$
 * @date $date$
 */

Edit variables：
1.user Default value：输入自己的名字
2.date Default value：time(“yyyy-MM-dd HH:mm:ss”)

使用方法：class前一行输入 jc ，然后按tab键

方法注释

步骤：选中UserTemplates -> 右侧点击 + Live Template
Abbreviation：*
Description：方法注释
Define：选择java
Template text：

*
 * 方法描述
 * $param$ $return$
 * @since $user$/$date$
 **/

Edit variables：
1.user -> Expression：”luoye”
2.date -> Default value：time(“yyyy-MM-dd HH:mm:ss”)
3.param -> Default value：groovyScript(“if("${_1}".length() == 2) {return ‘’;} else {def result=’’; def params="${_1}".replaceAll(‘[\\[|\\]|\\s]’, ‘’).split(‘,’).toList();for(i = 0; i < params.size(); i++) {if(params[i]==’null’){return;}else{result+=’\n’ + ‘ * @param ‘ + params[i] + ‘: ‘}}; return result;}”, methodParameters());
4.return -> Default value：groovyScript(“def returnType = "${_1}"; def result =’’;if(returnType==’null’||returnType==’void’){return;}else{result += ‘\n * @return ‘ + returnType; return result;}”, methodReturnType());

使用方法：方法前一行输入 /** ，然后按tab键

方法modify注释

步骤：选中UserTemplates -> 右侧点击 + Live Template
Abbreviation：mod
Description：方法修改时间
Define：选择java
Template text：

@since $user$/$date$

Edit variables：
1.user -> Expression：”luoye”
2.date -> Default value：time(“yyyy-MM-dd HH:mm:ss”)

使用方法：方法注释 @modify回车后输入：mod ，然后按tab键

效果

/**
 * 描述
 *
 * @author luoye
 * @date 2021-07-14 17:06:49
 */
public class UserService {

    /**
     * 方法描述
     * @since luoye/2021-07-14 17:07:14
     * @since luoye/2021-07-14 17:07:20
     * 
     * @param email: 
     * @param pwd:  
     * @return boolean
     **/
    public boolean login(String email,String pwd){

    }
}