Contents

Eclipse 版权生成器简介

1. 概述

众所周知,在 Eclipse IDE 中为源文件添加版权许可标头是一项困难且容易出错的任务。

在本教程中,我们将学习两种使这项任务变得简单且无错误的方法。第一个使用 Eclipse IDE 的代码模板特性。第二个使用版权生成器插件。

2. 使用代码模板

首先,让我们看看如何使用代码模板添加版权许可标头。让我们从 Eclipse 设置开始:

2.1. Eclipse设置

  • 从主菜单栏中,导航到首选项
  • 然后,导航到Java -> 代码样式 -> 代码模板
  • 从窗口的右侧,展开代码部分并选择新建 Java 文件

/uploads/eclipse_copyright_header/1.png

  • 然后,我们通过单击编辑按钮进入编辑模板
  • Edit Template窗口中,我们在Pattern文本区域中添加我们的版权许可标题
  • 并且,点击OK按钮更新模板
  • 最后,让我们点击应用按钮完成设置

/uploads/eclipse_copyright_header/3.png

2.2. 申请版权

现在,我们会自动将版权标头应用于每个新的 Java 源文件

/uploads/eclipse_copyright_header/5.png

但是,这种方法有一些缺点

  • 我们不能使用它向现有源文件添加版权标题
  • 我们不能在许可文本中包含自定义变量,例如我们的公司名称
  • 让我们选择不同的版权许可标头不够灵活
  • 我们只能在 Java 和 Javascript 源文件上使用它

幸运的是,版权生成器插件形式的替代方案。

3. 使用版权生成器插件

让我们从设置版权生成器插件开始。

3.1.安装插件

  • 我们通过导航到Help -> Eclipse Marketplace来安装插件
  • 然后我们在Find文本框中搜索Eclipse Copyright Generator
  • 最后,让我们点击安装按钮并按照说明进行操作

/uploads/eclipse_copyright_header/7.png

3.2. 自定义版权许可标头

所有标准版权许可标头都预装了该插件。

但是如果我们想添加一个自定义标题,或者编辑一个呢?让我们看看如何在Copyright Preferences中做到这一点:

  • 我们首先导航到Preferences -> General -> Copyright
  • 然后,要添加新的版权标题,我们单击添加按钮
  • 要修改现有许可证,我们从许可证中选择一个许可证**,然后单击修改**按钮

/uploads/eclipse_copyright_header/9.png

3.3. 申请版权

安装插件后,将版权许可标题应用于一个或多个源文件非常容易。

让我们看看如何将其应用于选定的源文件:

  • Project Explorer面板中,我们选择源文件
  • 然后,右键单击选定的源文件
  • 从上下文菜单中,我们选择应用版权 选项

同样,要将其应用于一个或多个项目:

  • 从主菜单栏中,选择项目 -> 应用版权

/uploads/eclipse_copyright_header/11.png

然后我们按照应用版权对话框中的说明将版权标题添加到文件中:

  • 我们点击下一步按钮,这会将我们带到版权设置

/uploads/eclipse_copyright_header/13.png

  • 然后,从版权类型选择框中选择版权许可

/uploads/eclipse_copyright_header/15.png

  • 然后,单击下一步按钮,将我们带到文件窗口
  • 最后,我们点击完成按钮,将版权标题应用到选定的源文件

现在与代码模板不同,插件不会在创建新文件时自动添加版权标题

但是,该插件与代码模板相比有几个优点

  • 为现有源文件添加版权许可标头很容易
  • 我们可以在许可证文本中包含自定义变量,例如公司名称
  • 该插件支持许多不同的版权许可标头
  • 我们可以为所有类型的源文件添加版权标头,而不仅限于 Java 源文件