IDEA代码文件的版权(copyright)信息配置_idea copyright

IDEA代码文件的版权(copyright)信息配置

  

1、快速创建Copyright 版权配置文件

1、创建copyright文件
    依次点击 File > Settings… > Editor > Copyright > 点击 “+” 号或 “Add profile”***，弹出创建 Copyright Profile 操作窗口，在***文本栏中输入版权配置文件的名称，文件名可自定义；

 
2、添加版权信息
    在 *Copyright text（may contain Velocity templates）*文本框中根据自身需求写入版权信息（如下），并点击 Apply 进行应用;

Copyright (c) xxxx my copyright message. 2022-${today.year}. All rights reserved. (根据需要自定义版权信息)
1

 
3、设置并使用创建好的版权文件
    退回至 Settings 中的 Copyright，在 Default project copyright 选项框中***选中刚刚创建好的版本文件***，点击 Apply 进行应用；

 
4、使用方法
    在新创建文件时，无需手动编辑，IDE会自动生成版本信息。

 
 

2、为所有新建项目自动配置版权信息

    通过以上 “步骤1 快速创建Copyright 版权配置文件” 的操作，可以完成 CopyRight Profile 版权文件的创建，并在当前项目中生效。但是在创建新的项目时，会发现新建的项目中并没有已经创建好的版权文件，打开设置查看也发现确实没有可用文件。
    此时如果不嫌麻烦，可以再次手动创建版权文件【手动狗头】。
    为了一劳永逸，我们可以将已存在的版权文件导入进来。此文件可以是别人发送过来的，也可以使用之前自行创建好的。默认的保存路径为：项目根路径.idea\copyright\xxxx.xml

    要导入已存在的copyright版权文件，依次点击 ***File > New Projects Settings > Settings for New Projects… ***进入全局配置，在这里进行的配置会对新建项目生效。【需要注意的是，各个版本的IDEA为新建项目所做的配置进入路径不一样，可以网上查找一下】

    之后同样进入了Settings设置框，依次点击 Editor > Copyright > Import 的箭头图标，弹出选择copyright文件的操作窗口，根据路径选择即可。

==注意：==不知为何，以前这么设置时是可以为新建项目自动配置版权文件的，但是当前在这个版本（2021.1）的IDEA中却不生效。需要排查下原因。
 
 

3、自定义版权信息模板

    通过添加自定义快捷模板cprt，可以在未添加版权声明的文件头以手动输入缩略语的方式快捷配置版权信息。

1、新建模板分组
    依次点击进入 ***File > Settings… > Editor > Live Templates，点击右侧 “+” 号并在弹出选项中选择 “Template Group…”***，用以新建自定义的模板分组，此处取名为 Custom。（可以将要创建的模板放在系统的分组中，但不建议；自行创建分组可以更好的管理自定义模板）
【若已经存在自定义模板分组，可直接进入第2步骤】

 
2、创建 cprt 模板
    选中已创建好的自定义模板分组，***点击右侧 “+” 号***并在弹出选项中***选择 “Live Template”***。

 
3、填充自定义模板信息
    新建模板后，需要配置模板相关信息。模板中各项参数以及作用如下：

• Abbreviation 缩略语：在此处填入触发缩略语，在Java文件中可以通过缩略语触发版权模板；
• Description 描述：对当前模板的描述，为可选项；
• Template Text 模板内容：版权信息模板的展示内容，根据需要来填写；
• Edit variables 变量编辑：若模板内容中填入的信息中带有变量，可以通过该设置项对变量进行格式化、赋值等操作；
• Expand with 手动触发按键：默认为 Tab 键，可保持默认，也可以自定义；
• Define 自定义作用域：可以选择 Everywhere ，也可以选择自定义的模块，比如此处选择 Java 模块中的 Declaration。
  

​ 此处在自定义的版权模板内容框中填入的信息如下：

/*
 * This is my custom copyright information.2022-${today.year}. All rights reserved.
 */
1
2
3

    在 Edit variables 变量赋值这一块，使用的是 date(“yyyy”) 函数返回值；默认值则填写了今年的字符串。【更多对 Edit variables 以及 Expression 函数 的补充说明见本文末尾】
 
4、使用方式
    在未添加版权信息的类头部输入缩略语（如此处的 cprt）则可生成版权信息。在新建工程中，无需额外设置，即可使用缩略语快速生成版权信息。

 
 

4、一键更新copyright作用范围

    以上操作仅能使 copyright 文件对当前项目新建的文件生效，或者需要一个一个文件进行手动添加版权信息。而对于想要给很多文件添加版权信息的人来说，这不是一个好办法。IDEA提供了一键快捷添加版权信息的功能，方式为：点击 Code > Update Copyright… > 在弹出的 Specify Update copyright Scope 操作窗口中选择生效范围，

• Whole Project：版权信息将更新至整个项目。
• File ‘…\xxx\xxx\xxx.java’：版权信息仅更新至选中的文件。
• Custom scope：版权信息在自定义文件范围内生效。
  
   
   
  【对 Edit variables 变量编辑的扩展】

    经测试，可以得出以下结论（其他场景可自行验证）：

• 写于模板内容 Template text 中的变量，需用 “$” 符号将变量名括起来，比如 ​$Date$；变量名可自定义；
• 变量名和变量取值函数没有一一对应关系，可以任意组合；
• 获取日期的函数 date() 默认格式为 “yyyy/MM/dd"，获取时间的函数 time() 默认格式为 “hh:mm”；
• 需要指定格式，则需自行传入格式参数，如指定日期格式为 “yyyy-MM-dd”，则在选择日期函数date()时传入格式参数，比如 date(“yyyy-MM-dd”)；
  
   
   
  更多对 Expression 函数、参数的意义解析如下表所示：