编程工具篇_IDEA_代码注释

注释模板

1 类模板

首先我们来设置IDEA中类的模板：（IDEA中在创建类时会自动给添加注释）

1.1 路径

File --> settings --> Editor --> File and Code Templates --> Includes --> Files
我们选择Class文件

1.2 内容

1. $NAME：设置类名，与下面的${NAME}一样才能获取到创建的类名
2. TODO：代办事项的标记，一般生成类或方法都需要添加描述
3. $USER、${DATE}、$TIME：设置创建类的用户、创建的日期和时间，这些事IDEA内置的方法，还有一些其他的方法在绿色框标注的位置，比如你想添加项目名则可以使用${PROJECT_NAME}
4. 设置版本号，一般新创建的类都是1.0版本，这里写死就可以了

类注释内容如下（直接复制即可）

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @ClassName ${NAME}
 * @Description TODO
 * @Author ${USER}
 * @Date Created in ${YEAR}-${MONTH}-${DAY} ${HOUR}:${MINUTE}
 * @Version 1.0
 */
public class ${NAME} {
}

1.3 效果图

package com.itcast.demo;

/**
 * @ClassName CommentDemo2
 * @Description TODO
 * @Author 高天昊
 * @Date Created in 2020-09-06 14:16
 * @Version 1.0
 */
public class CommentDemo2 {
}

2 设置方法注释模板

IDEA还没有智能到自动为我们创建方法注释，这就是要我们手动为方法添加注释，使用Eclipse时我们生成注释的习惯是/**+Enter，但是IDEA的默认快捷键是tab,这里就不作变化了

2.1 路径

1. File --> settiing --> Editor --> Live Templates
   

2. 添加组之后将abbreviation设置为*，然后在Template text中添加下面内容，然后点击Edit variables,分别设置对应的函数，其中param需要特别注意

*
 * @Author $user$
 * @Description //TODO $end$
 * @Date $date$ $time$ 
$param$
 * @return $return$
 **/

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())

在方法上输入“/*”再点击Tab键，结果如下：

package com.itcast.demo;

/**
 * @ClassName CommentDemo2
 * @Description TODO
 * @Author 高天昊
 * @Date Created in 2020-09-06 14:16
 * @Version 1.0
 */
public class CommentDemo2 {

    /*
     * @Author 高天昊
     * @Description //TODO 
     * @Date 2020/9/6 14:36 
     * @param name
     * @param age
     * @return java.lang.String
     **/
    private static String testMedthod(String name, Integer age) {
        return "";
    }
}