WebStorm 2025.2 Help

版权

您的项目可能包含您希望受版权保护的文件。 与其为每个文件单独添加版权声明，您可以使用 copyright profiles。

配置文件定义版权声明文本，以及要将此文本添加到其中的一组文件（范围）。

您可能需要为同一项目中的文件设置多个不同的版权声明。 在这种情况下，您可以配置多个配置文件，并将它们与不同的范围关联。

在 WebStorm 中，版权配置文件可以是 local或 shared。

共享配置文件存储于 .idea/copyright 的 .xml 文件中，并可通过 VCS 与团队其他成员共享。

本地版权配置文件存储在 IDE 层级，在当前 IDE 实例中打开的所有项目中均可使用。

配置文件可让您定义版权文本，稍后可以应用于整个项目或仅添加到特定文件中。

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

    要为所有新建项目配置默认配置文件，请选择 文件 | 新建项目设置 | 新项目的 设置 并转到 编辑器 | 版权 | 版权配置文件。

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

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

  4. 输入版权声明文本。

    您可以输入纯文本或配置 Velocity 模板。 对于模板，请使用 variables ，然后点击 验证 以确保配置正确。

    配置版权配置文件

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

版权变量

当前在 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

由 日期和时间模式字符串指定的日期和时间格式。 请参阅 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 ），然后从列表中选择现有共享的 范围。

    如有需要，您可以定义新的范围。 点击页面下方的 选择范围以添加或修改现有范围 链接。

  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 将为其分配 默认配置文件。

  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年 9月 26日
临时文件TODO 注释