Idea 注释设置

idea的注释真的,好像也不是那么不好设置。只不过设置了好几次,每次好长时间而已。

记录备忘。简单易懂,不喜勿喷。

前言

idea中的注释都是通过模板的方式添加的。
类的模板的,就是通过设置一个文件的模板,当你新建一个类的时候就能够生成你想要的注释的样子。就好像你新建了一个HTML一样,建好里面就是有东西的。
方法的模板通过live templates设置,这个其实就是通过把自己想要的内容设置一个简易缩写达到快速输入的效果,就好像sout,回车就有System.out.println();一样。

类的注释

setting-> file and Code templates -> file->Class.然后把那个下面的内容粘贴进去,替代原来的内容。然后类的注释就配置好了。下面的东西也不是一成不变的,根据需求自己修改吧。然后接口,和 枚举同理。

/**
 * @project:${PROJECT_NAME}
 * @package:${PACKAGE_NAME}
 * @filename:${FILE_NAME}
 *
 * Copy
 */
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * @typename:${NAME}
 * @brief: <一句话简述>
 * @author:${USER}
 * @date: ${DATE}  ${TIME}
 * @version: 1.0.0
 * @since
 */
public class ${NAME} {
}

类里面的注释

这个也是通过模板实现的。setting->Live Templates.
进来之后一定可以看到右边的两个很熟悉的符号。加号和减号。
idea自有的模板还比别改了,毕竟自己这么菜,要是改坏了怎么办。
所以点加号,新建一个模板组,
然后在自己新建的模板组里面自定义模板就好了。
选中自己新建的模板组,然后还点加号,这次选择新建模板。
然后给模板填上一个缩写(abbreviation)。后面的描述自己填一下,七个备忘的作用。
最下面有一行字最后一个单词可能是红色的或者蓝色的点他,然后选java。
下面就是模板的内容了。
依次在模板组添加以下的注释模板。

属性的注释

属性的注释我用的是默认的。就是/**回车。有需要的和方法的注释类似。

方法的注释

*
 * @Description:
$param$
 * @return $return$
 * @throws
 **/

这里有个小重点。

然后方法的注释里面写了点东西。
这时候点右边的那个 编辑变量(Edit variables)然后选个表格式就好了。
看看方法名就知道怎么选了,别着急。
return还比较好选。
不过param,建议直接复制下面的贴上去。看看就懂了的东西。

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

然后那个throws我没有找到合适的表达式。也可能没有吧。
但是idea默认的注释是有的(就是直接在方法上/**回车)。回头我知道了在更新吧。有人看到,还请勿喷。

getter和setter有更秀的

getter和setter的传送门

你可能感兴趣的:(工具使用tip)