idea配置File and Code Templates

快来打我* 2021-09-23 08:06 729阅读 0赞

一、需求说明

idea版本是2018.1，不同版本之间可能会有差异。

这里以后台java代码的注释模板为例（用Class来举例），模板的差异部分在于File Header.java这块

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70][]

场景一：idea里有20个项目，其中10个是自己没事写的小demo，另外10个是公司开发的项目

自己写的小demo是一套注释模板，公司开发的项目是一套注释模板

场景二：idea里有10个项目，其中8个是公司的项目，另外2个是客户的项目

公司开发的项目是一套注释模板，客户的项目的注释模板各不相同

二、解决方法

都是在Editor->File and Code Templates中配置。

场景一：

这种情况是有两套代码模板，而且都用的比较多

File->Other Settings->Default Settings->Editor->File and Code Templates->选中Files和Includes里的Default（注意：不是Ctrl+Alt+S里点出来选的Default）

不建议直接改Files选项卡的内容，最好是把公用的地方抽出来，放到includes选项卡里。比如说：Class、Interface、Enum基本上都会共用相同的File Header注释，像下面这样，我只要修改File Header，这几种java文件的头部注释都会跟着变化

假定下面这个是小demo的注释模板

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70 1][]

（File Header是idea自带提供的模板，如果你修改后觉得不是想要的效果，可以选中File Header，然后点上面横条的恢复按钮，放上去会显示“Reset to Default”）

然后我们再配置公司开发项目的模板，

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70 2][]

经过这样配置之后，随便打开一个项目，新建一个Class都会有两个选项（一个是Class，另一个是Classcompany）

![20190922205131847.png][]

如果某个项目在（Ctrl+Alt+S）改了Default的东西，别的所有项目包括Default Settings里的Default也会发生变化

场景二：

其中8个使用的是相同模板的File Header就用默认的（这个默认的是没法配的，不像不同项目的Default可以从Default Settings里的Default里继承过来，不同项目的Project没法从Default Settings里统一继承一个Project选项的设置，还是得一个个配，比较麻烦），所以就是使用Default选项

只有个别项目（剩下2个项目）的各自模板不太一样，需要分别改下

Ctrl+Alt+S->Editor->File and Code Templates->选中Files和Includes里的Project

这样配置出来的模板只是在你自己这个项目里生效，新建一个项目是按照Default Settings里来

比如：项目A的模板是

![20190922205601289.png][]

项目B的模板是

![20190922205627581.png][]

选中Project的情况下，只要改下File Header就行了，不同项目之间不会被影响

三、总结

对于File and Code Templates中的Files和Includes选项卡，

1. Default Settings的Default会影响各个项目（Ctrl+Alt+S的配置是跟着项目走的）的Default，各个项目的Default之间会项目影响

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70 3][]

2. 各个项目的Project设置之间是互不影响的

3. Default和Project之间没有关系

参考链接：

[https://www.jianshu.com/p/476479db317f][https_www.jianshu.com_p_476479db317f]

[https://blog.csdn.net/baidu\_25797177/article/details/78920322][https_blog.csdn.net_baidu_25797177_article_details_78920322]

[https://blog.csdn.net/sdut406/article/details/81750858][https_blog.csdn.net_sdut406_article_details_81750858]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70]: /images/20210923/ece24dbcc6ba483c86d2ac45c51fb222.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70 1]: /images/20210923/08a5e02f02764b2da6e0caf6f31c1903.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70 2]: /images/20210923/8c412ee19c864d238d6405984a2f53ae.png
[20190922205131847.png]: /images/20210923/415b18f5840940eb980d9b3de8d41cca.png
[20190922205601289.png]: /images/20210923/15a7ba3ea9684017b494d6bdb8980acf.png
[20190922205627581.png]: /images/20210923/cbd8665248e44ea083f0271c65cab96a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTA5OTk4MDk_size_16_color_FFFFFF_t_70 3]: /images/20210923/1352f08b22fc46b9881c7370b854f438.png
[https_www.jianshu.com_p_476479db317f]: https://www.jianshu.com/p/476479db317f
[https_blog.csdn.net_baidu_25797177_article_details_78920322]: https://blog.csdn.net/baidu_25797177/article/details/78920322
[https_blog.csdn.net_sdut406_article_details_81750858]: https://blog.csdn.net/sdut406/article/details/81750858