WebStorm 2026.3 Help

版权配置文件

版权资料页

使用此页面配置选定的配置文件:定义要生成的版权声明,并指定在注释中检测版权声明的关键字。

条目

描述

名称

使用此文本字段查看或编辑所选版权配置文件的名称。

通过 VCS 分享

选中此复选框可将配置文件存储在 .idea 目录中,并通过 VCS 与团队共享。 如果清除此复选框,WebStorm 会在 IDE 级别存储该配置文件,并将其应用于所有项目。

版权文本(可包含 Velocity 模板)

使用此文本区域查看或编辑要生成的版权声明。 版权文件可以包含版权声明的明确纯文本或通过 Velocity 模板定义其内容。

当前,Velocity 上下文中可用以下变量:

名称

类型

注释

$today

DateInfo

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

$file.fileName

字符串

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

$file.pathName

字符串

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

$file.className

字符串

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

$file.qualifiedClassName

字符串

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

$file.lastModified

DateInfo

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

$project.name

字符串

当前项目的名称。

$username

字符串

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

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

字符串

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

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

可以省略 ignoreValue。 如果只传递 regexp ,则 group 为 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)

字符串

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

例如,以下模板会插入当前年份和当前用户的名称:

Copyright (c) $today.year $username

要保留原始年份并仅更新最后一个年份,例如,将 2022 - 2025 更改为 2022 - 2026 ,请使用 $originalComment.match:

Copyright (c) $originalComment.match("Copyright \(c\) (\d+)", 1, " - ", "$today.year")$today.year $username

在新声明中,此模板只插入当前年份,例如 Copyright (c) 2026 jsmith。 更新现有声明时,它会从旧声明中获取第一个年份,并在其后添加当前年份。 如果旧声明已经以当前年份开头, ignoreValue 会防止出现 2026 - 2026 这样的范围。 如需更多信息,请参阅 版权模板中的日期。

Validate

点击此按钮以检查 Velocity 模板是否已正确指定。

用于在注释中检测版权的正则表达式

使用此字段来输入、查看或编辑 正则表达式 ,该正则表达式将用于在注释中查找版权声明。

请注意,此正则表达式应与上面指定的版权声明匹配。 否则,WebStorm 将插入新的版权声明,而不是 更新现有的。

如果旧版权匹配,则允许替换版权

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

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

请注意 用于在注释中检测版权的正则表达式 和 如果旧版权匹配,则允许替换版权 之间的区别。 第一个设置用于查找版权声明,第二个设置用于决定是否更新找到的版权声明。

运作方式

2026年 11月 6日