idea的类注释、方法注释及自定义快捷键

文章目录

• • • • 1. 类注释
      • 2. 方法注释
      • 3. 自定义快捷键
      • 4. 注释内容展示

1. 类注释

1. 文件创建时生成：File->Settings->Editor->File and Code Templates->Class；

2. 自定义：自定义快捷键路径（File->Settings->Editor -> Live Templates ->) 。

   文件创建时生成注释：

   

   

2. 方法注释

1. /** + Enter ：eclipse 和 idea 都适用；
2. Alt + Enter ：选中方法名称(或则光标在方法名称上)，然后按快捷键，再选择"add javadoc"；
3. 自定义：自定义快捷键路径（File->Settings->Editor -> Live Templates ->) 。

3. 自定义快捷键

路径：File->Settings->Editor -> Live Templates ->

这里添加一个方法注释举例：

4. 注释内容展示

/**
 * 〈功能简述〉
 *
 * @author byrc
 * @version 1.0.0
 * @date: 2020/08/04 14:41
 */
public class CommentTest {

    /**
     * /** + Enter 生成方法注释
     * @param arg
     * @param mark
     * @return
     * @throws BusinessException
     */
    private String test1(String arg, Boolean mark) throws BusinessException {
        return arg;
    }

    /**
     * Alt + Enter (选择 "add javadoc") 生成方法注释
     * @param arg
     * @param mark
     * @return
     * @throws BusinessException
     */
    private String test2(String arg, Boolean mark) throws BusinessException {
        return arg;
    }

    /**
     * 自定义快捷键 生成方法注释
     * @param
     * @return
     * @throws`在这里插入代码片`
    */
    private String test3(String arg, Boolean mark) throws BusinessException {
        /**
         * 在方法内生成才能拿到 注释上的变量信息。。。
         * @param [arg, mark]
         * @return java.lang.String
         * @throws 
        */
        return arg;
    }
}
           

自定义注解中的参数获取是 数组（methodParameters()），有一种处理方法，eg: