Idea-Java代码注释规范

 

IDEA自带的注释模板不是太好用，我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家（如果嫌配置繁琐，可以在本页面最下方下载jar包，导入idea，就可以了）。

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

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

这里贴出我的配置，Class、Interface、Enum、Annotation的配置都是一样的，大家复制粘贴即可，不要修改其他配置，直接点击"Apply"。

// Copyright 2016-2101 Pica.
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end

/**
*@ClassName     ${NAME}
*@Description   TODO
*@Author        ${USER}
*@Date          ${DATE} ${TIME}
*@ModifyDate    ${DATE} ${TIME}
*@Version       1.0
*/
public class ${NAME} {
}

我们新建一个类试试吧！

大家可以看到，该有的都有了。

 

二、接下来我们设置方法的注释，这里会比类注释的设置稍微麻烦一点。

1. File > settings > Editor > Live Templates
2. 点击右侧的"    +    "，新建模板组，名称自定义，如下图。

 

3.新建模板。
选中新建的模板组，点击右侧的"    +    "，选择"Live Template"

如下图设置模板信息。

这里先点击蓝色的"Define"，设置为"Java"，或者你想设置为全部也可以。

以下是完整配置。

*

*@Description TODO

*@Author $user$
*@Date $date$ $time$
*@ModifyDate $date$ $time$
*@Params $params$
*@Return $return$
*/
注意："Abbreviation"内的内容必须为“    *     " （单个*号），"Template text"的内容开头没有"     /*     "。 
点击"Edit variables"

请按照图片配置"Expression"内容。 
保存后，新建一个方法，在添加方法注释的地方，做"/**" + "Enter"的操作（与以前的操作一样），即可看到设置的效果。