idea添加文件头信息user

一般在新建的时候，user默认取的是电脑的主机名，这个不是我们想要的。可如果还有什么类型，没提到的，自己找找自己要用的就可以啦。一个道理。可以分别点击class，interface，enum，等等，可以看到右边的编辑框里面都有一个#parse（“file header.java”）

这个就是相当于引入头文件一样：#include xxxx。为了复用。然后再看下面的includes，就看到了这个file header文件啦。你修改了这个地方，那么所有的引用了这个文件的地方就修改啦。user默认值为admin，想修改user的值的话，需要找到IDEA安装目录下的bin，在idea.exe.vmoptions和idea64.exe.vmoptions最后都加一句（Sakura替换为你的名字，不要使用在Intellij IDEA中的注释模板中的${user}名称是根据当前 *** 作系统的登录名来取的，有时候登录名称和我们实际的user名称并不相同。在用到方法二的时候遇到一个问题，在修改idea64.exe.vmoptions文件后,重启idea并没有生效。最后发现idea加载的配置文件根本不是bin文件夹下面的。我的是在c:\用户\tec\.IntelliJIdea2019.1\config这个路径下面的idea64.exe.vmoptions。打开配置最后一行加上：-Duser.name=nihao(这里放你自己要取得名字)，然后重启idea即可。

使用阿里编码规约扫描插件扫描代码的时候，我们会发现这样的提示，这是因为没有在代码中添加代码文件创建者、创建日期信息的注释信息，这篇文章我们来看一下怎样在eclipse和idea中设置@author（作者）@date（日期）信息；

在这里插入图片描述

eclipse中的设置

Window->Preferences，进入参数设置页面；

参数设置页面左侧Java->Code Style->Code Templates，右侧展开Comments，点击Types，点击右侧Eidt…将内容修改为一下内容，并勾选底部Automatically add comments for new methods and types复选框，点击右下角Apply；设置页面左侧Editor->File and Code Temples，右侧依次选中Includes->File Header(如果没有点击"+"创建一个)，在右侧填写以下内容，记得将${USER}项换成你自己的名字或者昵称，否则会用电脑当前的登录名来作为@author的值，完成之后，点击右下角Apply；在使用阿里编码规约扫描插件扫描代码的时候，我们会发现这样的提示，这是因为没有在代码中添加代码文件创建者、创建日期信息的注释信息，这篇文章我们来看一下怎样在eclipse和idea中设置@author（作者）@date（日期）信息；一般在新建的时候，user默认取的是电脑的主机名，这个不是我们想要然后再看下面的includes，就看到了这个file header文件啦。你修改了这个地方，那么所有的引用了这个文件的地方就修改啦。

IntelliJ IDEA如何修改新建文件自动生成注释的user名

好像只修改下面的file header里面的值就可以啦。原理，已经在上面说明了。

IntelliJ IDEA如何修改新建文件自动生成注释的user名

IntelliJ IDEA如何修改新建文件自动生成注释的user名

找到文件和代码的模板设置.Preferences->Editor->File and Code Templates，然后在Templates这个tab下，选择你需要修改的文件类型的头模板。

修改注释.选中上一步的某一个类型以后，将#parse("File Header.java")这一行删除。替换为你自己的注释，例如：#if (${PACKAGE_NAME} &&${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end

/**

* ${NAME}

*

* @author Li Cong

* @date ${DATE}

*/

public @interface ${NAME} {

}

挨个类型都修改，然后点击右下角的Apply和OK就可以了。

IDEA配置方法注解：设置类--接口---枚举注解模板

#if (${PACKAGE_NAME} &&${PACKAGE_NAME} != "")package ${PACKAGE_NAME}#end

/**

* Created by tom_plus on ${YEAR}年${MONTH}月${DAY}日

*/

public class ${NAME} {

}

在Java程序中Javadoc注释很重要，但是很多时候注释被漏掉，看看项目中的代码就会知道。如果你结对编程的话，你的伙伴一定会说，“哥们，这儿注释丢掉啦，那个函数的Javadoc注释写的不正确！”。项目中有很多的开发人员，水平和习惯都不太一样，但是对程序中javadoc注释来说，这是不能变化的，要规范起来。如何让每一个人都能养成这样的习惯呢？下面我们就IntelliJ IDEA使用向大家介绍一下。

IDEA默认对Javadoc的支持非常不错，但是这里我们要引入一个插件，那就是JavaDoc Sync Plugin，这两者的结合将非常完美：JavaDoc Sync Plugin会提示你添加javadoc注释及注释同步，而IDEA本身会校验javadoc语法，这样我们的工作就会简单很多。

首先打开Plugin Manager下载并安装JavaDoc Sync Plugin，重启IDEA后在设置面板中选择“Errors”选项，在“Errors”对话框中的文本过滤栏输入javadoc， 这时就会出现和javadoc相关的设置选项 这里我们想对这些设置项进行说明：

Declaration has javadoc problem：这个设置项主要是校验javadoc的语法错误，如不必要的javadoc注释，必需的tag丢失等等。这个设置项有很多的参数设定，你可以参考一下；

Inconsistent Javadoc主要检测javadoc注释冲突，如接口和实行类的javadoc不一致；

Missing Class Javadoc delcaration等提示你应该添加注释。

Severity最右边的小按钮可以设置错误级别显示效果。

有了这些配置，相信你不在会忘记添加javadoc注释啦，因为IDEA会实时地给你指出来（高亮、背景等），这是IDEA的代码审查特性。IDEA同时提供了快速添加和纠错注释功能，只需一个键盘 *** 作，就可以完成注释添加、同步和纠错。

总结：通过以上设置，相信每一个人都会养成编写Javadoc的好习惯，格式统一。如在版本控制系统管理下，java类的注释需要@author和@version tag，这样每个人都会加上，对管理代码有很大的帮助。IDEA同时允许你给不同的错误级别设置不同的显示效果，这样你文档中各种问题进行标识，方便管理。

---