GoLand 2026.3 Help

版权

您的项目可能包含您想通过版权保护的文件。 与其对每个文件单独添加版权声明，您可以使用 版权配置文件。

配置文件定义了版权声明文本和一组文件（作用域 ），这些文件将会被加入该文本。

对于同一项目中的文件，您可能需要几个不同的版权声明。 在这种情况下，您可以配置多个配置文件并将它们与不同的作用域关联。

在 GoLand 中，版权配置文件可以是 本地的和 共享的。

共享 配置文件保存在 .idea/copyright 中的 .xml 文件，并通过 VCS 提供给团队其他成员。

Local 版权配置文件存储在 IDE 级别，并且在您打开的当前 IDE 实例中的所有项目中可用。

配置文件允许您定义版权文本，之后您可以在整个项目中插入或仅添加到特定文件。

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器 | 版权 | 版权配置文件。

    要配置所有新建项目的默认配置文件，请选择 文件 | 新项目设置 | 设置 用于新项目 并前往 编辑器 | 版权 | 版权配置文件。

  2. 点击 添加 并命名新配置文件。

  3. 选择 通过 VCS 共享 将此配置文件放入 .idea 文件夹并与您的团队共享，或者取消选中复选框以在本地保留此配置文件并使其在所有项目中可用。

  4. 输入版权声明文本。

    您可以输入纯文本或配置 Velocity 模板。 模板中，使用 变量 ，并点击 验证 确保其配置正确。

    配置版权配置文件

配置好配置文件后，您可以 选择要添加文本的文件作用域 ，或 将此配置文件设置为默认配置 ，应用于项目中未包含在任何作用域内的所有文件。

版权变量

当前，Velocity 上下文中可用的变量如下：

名称

类型

注释

$today

DateInfo

当前日期和时间。 将其与 DateInfo 属性结合使用，例如， $today.year 会插入当前年份。

$file.fileName

String

当前打开的文件的名称，以生成通知。

$file.pathName

String

当前打开的文件的完整路径和名称将在此处生成通知。

$file.className

String

在 Java 和 Groovy 文件中，类的名称。 在其他文件中，为文件名称，与 $file.fileName 相同。

$file.qualifiedClassName

String

在 Java 和 Groovy 文件中，类的完全限定名称。 在其他文件中，文件的完整路径和名称，与 $file.pathName 相同。

$file.lastModified

DateInfo

当前文件最后一次更改的日期和时间。 将其与 DateInfo 属性结合使用，例如， $file.lastModified.year。

$project.name

String

当前项目的名称。

$username

String

当前操作系统用户的登录名称。

$originalComment.match(regexp, group, suffix, ignoreValue)

String

由 regexp 在现有版权声明的 组 组中捕获的文本，后跟 suffix。 在更新声明时，用它保留原始年份。

如果没有现有声明、 regexp 与其不匹配，或者捕获的文本等于 ignoreValue ，则返回空字符串。

可以省略 ignoreValue。 如果只传递 regexp ，则 组 为 1 ，并且不会添加后缀。

$today 和 $file.lastModified 具有以下属性和方法。 该表使用 $today 显示它们。 对于上次修改日期，请使用带有 $file.lastModified 的相同名称，例如， $file.lastModified.year。

名称

类型

注释

$today.year

int

年份，例如， 2026。

$today.month

int

月份 (1-12)。

$today.day

int

当月的日期 (1-31)。

$today.hour

int

12 小时格式 (0-11) 的小时。

$today.hour24

int

24 小时格式 (0-23) 的小时。

$today.minute

int

小时中的分钟数 (0-59)。

$today.second

int

分钟中的秒数 (0-59)。

$today.format(String format)

String

使用 日期和时间模式 进行格式设置的日期和时间，例如， $today.format("yyyy-MM-dd") 返回 2026-10-01。

默认情况下，版权模板包含两个年份：原始年份和当前年份。

如果您插入新的版权声明，原始年份将与当前年份匹配，因此只会添加一个年份（例如， 2021）。 第二年，当您更新您的版权时，您将能够重新生成通知，这样原始年份将与当前年份一起显示（2021 – 2022）。 这样每次更新版权时，您就不必手动添加年份。

在模板中，原始年份使用 $originalComment.match("Copyright \(c\) (\d+)", 1, "-") 代码提取，当前年份使用 $today.year 插入。 从 GitHub 上的源代码了解更多信息。

设置中的版权模板

请注意，如果新版权的格式与模板中先前的版权格式匹配，则年份将正确更新。 因此，请确保编辑模板中从文件中提取年份的部分，使其与原始版权的格式匹配。

例如，如果您的原始通知是 Copyright 2019-2021 MongoDB, Inc. ，请从模板中删除版权符号 (c)： $originalComment.match("Copyright (\d+)", 1, "-")。

将配置文件分配给文件范围

请选择您要添加已配置版权文本的 作用域 文件：

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器｜版权。

  2. 点击 添加 （或按 Alt+Insert ），并从列表中选择一个现有的共享 作用域。

    您可以在必要时定义一个新的 scope。 请点击页面底部的 选择作用域以添加作用域或修改现有作用域 链接。

  3. 从 版权 列表中选择您要与作用域关联的配置文件。

  4. 应用更改并关闭对话框。

    将配置文件与作用域关联

之后，您可以 将版权添加到必要的文件中。

设置默认版权配置文件

默认配置文件的设置将应用于未明确包含在任何配置文件作用域内的文件。

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器｜版权。

  2. 从 默认项目版权 列表中选择您要用作默认配置文件的配置文件。

  3. 应用更改并关闭对话框。

    之后，您可以 将版权添加到必要的文件中。

默认情况下，IDE 会在每行的前缀注释之前粘贴块注释，并在块之后添加一个空行。

默认格式的版权声明

您可以更改所有文件的默认格式，也可以分别为每种文件类型更改默认格式：

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器｜版权｜格式。

  2. 在此页面，您可以配置所有类型文件的格式。

    要更改特定文件类型的格式，请在 格式设置 节点下选择它。

  3. 配置格式选项。 请使用预览部分来确保新格式看起来符合您的预期。

    更改版权声明的格式

如果您想在另一个项目中使用配置文件，请将包含配置文件设置的 .xml 文件复制到不同位置，然后导入：

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器 | 版权 | 版权配置文件。

  2. 点击 导入配置文件 ，在打开的对话框中，选择包含您要使用的配置文件的 .xml 文件。

  3. 如果需要，请更改配置文件的名称，然后点击 确定。

    如果成功导入设置，您将看到确认弹窗。

    确认已导入版权配置文件的弹窗

  • 要将文本插入单个文件中，请在编辑器中打开文件，按 Alt+Insert ，然后从弹出窗口中选择 版权。

  • 若要将文本插入到一组文件中，请右键点击 项目 工具窗口中的节点，然后选择 更新版权。 您将被提示选择更新通知的作用域。

    一个节点可能包含属于不同作用域的文件。 在这种情况下，版权声明将根据分配的配置文件生成。

    如果一个节点包含一个不属于任何作用域的文件，IDE 会为其分配 default profile。

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 编辑器 | 版权 | 版权配置文件。

  2. 选择所需的配置文件并编辑版权文本。

  3. 在 用于检测注释中版权的正则表达式 字段中，指定用于在文件中查找现有版权声明的正则表达式。

    IDE 将使用此表达式在其他注释中识别版权注释。 例如，这类注释通常包含单词 版权。

  4. 在 如果旧版权匹配，则允许替换版权 字段中：

    可以选择指定一个正则表达式，用于限制 GoLand 更新哪些现有版权声明。 仅当此表达式与声明文本的某些部分匹配时，GoLand 才会替换检测到的声明。 该表达式区分大小写。 如果将字段留空，GoLand 会替换所有检测到的声明。

    例如，要更新您公司的声明并使第三方代码中的声明保持不变，请指定公司名称： Acme Corp。

  5. 应用更改并关闭对话框。

  6. 在 项目 窗口中（Alt+1 ），右键点击您要更新文本的节点，然后选择 更新版权。

您可以配置 IDE，使其在每次保存更改时更新版权声明。

  1. 按下 Ctrl+Alt+S 打开设置，然后选择 工具 | 保存时的操作。

  2. 请选择 更新版权声明 复选框。

    如果您已配置至少一个 版权配置文件并 指定该配置文件的文件作用域 ，则复选框可用。

    如果您还没有配置个人资料，请点击 配置… 链接。

    在设置中配置更新版权声明选项

    配置好配置文件后，返回 工具 | 保存时的操作 并启用 更新版权声明 复选框。

  3. 应用更改并关闭对话框。

有关您可以在保存时启用的操作的更多信息，请参阅 保存更改时触发操作。

2026年 11月 9日
文本方向自然语言