IntelliJ中为Java源文件添加版权许可证标头
1. 概述
在本教程中,我们将了解如何将许可证头添加到我们的 IntelliJ IDEA 项目文件中。许可证标头通常描述项目文件的允许使用和所有权。
我们假设您对 IntelliJ 有基本的了解 ,因此,我们将直奔主题。
2. 配置License Header
让我们打开我们现有的任何项目来配置许可证头。我们首先需要通过单击 IntelliJ IDEA 菜单项或按 Command + Comma
键来访问Preference窗口。
新的弹出窗口将在左侧显示菜单列表,我们可以从中单击Editor > Copyright > Copyright Profiles。为了更快地访问,我们可以在首选项窗口的搜索栏中输入Copyright 。
在窗口的右窗格中,让我们单击顶部的“+”按钮来创建新的版权配置文件。
我们首先给它一个名字——例如MIT License —— 然后点击“OK”:
在此之后,我们将许可证文本添加到文本区域。
我们使用了一个示例文本,最终应该用我们自己的替换:
**我们将<YEAR>替换为占位符 - $today.year。**每次我们使用配置文件时,IntelliJ 都会自动将其翻译为当前年份。
IntelliJ 定义了我们可以在版权配置文件中使用的其他变量。有关详细信息,请查看帮助页面 。
最后,让我们单击许可证文本正下方的“验证”按钮,以验证我们的文本并确保一切正常,然后单击“应用”以保存配置文件。
接下来是将配置文件设置为默认配置文件。我们可以通过点击Editor > Copyright并选择 MIT License 作为默认项目版权来实现:
3. 在项目文件中使用创建的版权配置文件
现在,是时候在我们的项目文件中使用版权配置文件了。我们可以通过按 Control + Return
键并选择版权菜单来实现这一点:
这会将我们之前设置为默认值的版权文本应用到项目文件的最顶部。
如果我们对结果文本的格式不满意,我们可以转到首选项>编辑器>版权>版权配置文件对其进行编辑,然后单击“应用”。之后,我们必须清除现有文本并按 Control + Return
键以应用更新的文本。
随后,我们创建的任何新项目文件都将自动具有许可证头,无需手动添加。