WebStorm 2025.3 Help

版权

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

配置文件定义了版权声明文本以及要插入该文本的一组文件（一个作用域）。

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

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

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

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

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

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

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

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

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

  4. 输入版权声明文本。

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

    配置版权配置文件

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

版权变量

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

名称

类型

评论

$today

DateInfo

当前日期和时间。

$file.fileName

String

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

$file.pathName

String

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

$file.className

String

当前打开的 Java 文件的名称，其中将生成通知。

$file.qualifiedClassName

String

当前正在打开的文件的完全限定名称，其中将生成通知。

$file.lastModified

DateInfo

当前文件最后一次更改的日期和时间。

$project.name

String

当前项目的名称。

$username

String

当前用户的名称。

DateInfo 具有以下属性：

year

int

当前年份。

month

int

当前月份（1-12）。

day

int

当前的日期 (1-31)。

hour

int

当前小时（0-11）。

hour24

int

当前小时（0-23）。

minute

int

当前小时的分钟数（0-59）。

second

int

当前的秒数（0-59）。

DateInfo 有以下方法：

format(String format)

String

日期和时间格式由 date and time pattern 字符串指定。 请参阅 java.text.SimpleDateFormat 格式选项。

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

如果您插入新的版权声明，原始年份将与当前年份匹配，因此只会添加一个年份（例如， 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。 请点击页面底部的 选择 Scopes 以添加范围或修改现有范围 链接。

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

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

    将配置文件与作用域关联

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

设置默认版权配置文件

默认配置文件的设置将应用于未显式包含在任何配置文件所覆盖的作用域中的文件。

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

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

  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 将使用此表达式在其他注释中识别版权注释。 例如，这类注释通常包含单词 Copyright。

  4. 在 如果旧版权匹配，则允许替换版权 字段中，指定 IDE 将用于搜索需要更新版权文本的文件的正则表达式。

    例如，如果您想更新所有包含 2000 至 2006 年及 2010 至 2016 年版权的文件中的版权文本，请指定 20[0-1][0-6]。

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

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

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

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

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

    仅当您已配置至少一个 版权配置文件 ，并 指定了应用此配置文件的文件作用域 时，复选框才可用。

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

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

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

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

最后修改日期： 2025年 12月 8日
临时文件TODO 注释