关于idea自动加入注释

关于idea [a] 自动加注释

之所以写这个,主要看到很多大佬的代码头部注释特别多,而且很详细.于是自己也想试试

  • 首先我们应该知道在哪里开始
    首先进入Preferences->editor->File and Code Templates ->class
    不同的操作系统进入,idea的设置可能不一样.我的这个是Mac,如果是window应该是setting.如下图所示
    idea注释1
  • 然后开始操作
    开始的代码显示如下,其实不用管.

    #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
    #parse("File Header.java")
    public class ${NAME} {
    }
    

    (1). ${NAME}: 可以查看在头部注释生成类名.

    (2).${USER}、${DATE}、${TIME}:设置创建类的用户、创建的日期和时间,这些事IDEA内置的方法,还有一些其他的方法在绿色框标注的位置,比如你想添加项目名则可以使用${PROJECT_NAME}

(3).`@Description: $description 可以在创建类之后加入注释,会自动生成注释`.

  • 下面是我的代码[b]
#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 * 作者: 是小文啊
 * QQ: 1612902996
 * 博客: xiaowen666.vip
 *描述:
 * 七月的风 八月的雨 
 *卑微到我喜欢遥远的你
 *类名: ${NAME}
 *编辑日期: ${DATE}
 *编辑时间: ${TIME}
 *@Description: $description 
 */
public class ${NAME} {
}

  • 下面是显示效果 idea注释2idea注释3idea注释4

 

[a] 所有JetBrains軟件公司的软件都基本通用,例如CLION,webstrom等.
[b] 文字地方可以写自己想写的,然后还有很多其它功能,作者实在不想折腾了