1. 概要

Eclipse IDEでソースファイルに著作権ライセンスヘッダーを追加することは、困難でエラーが発生しやすい作業であることが知られています。

このチュートリアルでは、このタスクを簡単でエラーのないものにする2つの方法を学習します。 1つ目は、EclipseIDEのコードテンプレート機能を使用します。 2つ目は、CopyrightGeneratorプラグインを使用します。

2. コードテンプレートの使用

まず、コードテンプレートを使用して著作権ライセンスヘッダーを追加する方法を見てみましょう。 Eclipseのセットアップから始めましょう:

2.1. Eclipseのセットアップ

  • メインメニューバーから、環境設定に移動します
  • 次に、Java->コードスタイル->コードテンプレートに移動します。
  • ウィンドウの右側から、コードセクションを展開し、新しいJavaファイルを選択します。

  • 次に、編集ボタンをクリックしてテンプレートの編集に移動します
  • テンプレートの編集ウィンドウで、パターンテキスト領域に著作権ライセンスヘッダーを追加します
  • そして、OKボタンをクリックしてテンプレートを更新します
  • 最後に、[適用]ボタンをクリックしてセットアップを完了しましょう

2.2. 著作権の適用

これで、新しいJavaソースファイルごとに著作権ヘッダーが自動的に適用されます。

ただし、この方法にはいくつかの欠点があります

  • これを使用して、既存のソースファイルに著作権ヘッダーを追加することはできません
  • 会社名のように、ライセンステキストにカスタム変数を含めることはできません
  • 別の著作権ライセンスヘッダーを選択できるほど柔軟ではありません
  • これは、JavaおよびJavascriptソースファイルでのみ使用できます

幸いなことに、著作権ジェネレータプラグインの形で代替手段があります。

3. CopyrightGeneratorプラグインの使用

CopyrightGeneratorプラグインを設定することから始めましょう。

3.1. プラグインのインストール

  • ヘルプ->Eclipseマーケットプレイスに移動してプラグインをインストールします
  • 次に、[Find]テキストボックスでEclipseCopyrightGeneratorを検索します
  • 最後に、インストールボタンをクリックして、指示に従いましょう。

3.2. 著作権ライセンスヘッダーのカスタマイズ

すべての標準著作権ライセンスヘッダーは、プラグインとともにプレインストールされています。

しかし、カスタムヘッダーを追加したり、編集したりする場合はどうでしょうか。 著作権設定でその方法を見てみましょう。

  • まず、[設定]->[一般]->[著作権]に移動します
  • 次に、新しい著作権ヘッダーを追加するには、[の追加]ボタンをクリックします
  • 既存のライセンスを変更するには、ライセンスからライセンスを選択し、変更ボタンをクリックします。

3.3. 著作権の適用

プラグインをインストールした後、著作権ライセンスヘッダーを1つ以上のソースファイルに適用するのは非常に簡単です。

選択したソースファイルに適用する方法を見てみましょう。

  • プロジェクトエクスプローラーパネルから、ソースファイルを選択します
  • 次に、選択したソースファイルを右クリックします。 
  • コンテキストメニューから、著作権の適用オプションを選択します

同様に、これを1つ以上のプロジェクトに適用するには:

  • メインメニューバーから、プロジェクト->著作権の適用を選択します

次に、著作権の適用ダイアログボックスの指示に従って、ファイルに著作権ヘッダーを追加します。

  • 次へボタンをクリックすると、著作権設定に移動します。

  • 次に、著作権タイプ選択ボックスから著作権ライセンスを選択します

  • 次に、次へボタンをクリックすると、ファイルウィンドウが表示されます。
  • 最後に、終了ボタンをクリックして、選択したソースファイルに著作権ヘッダーを適用します

コードテンプレートとは異なり、プラグインは、新しいファイルの作成時に著作権ヘッダーを自動的に追加しません。

ただし、プラグインには、コードテンプレートに比べていくつかの利点があります。

  • 既存のソースファイルの著作権ライセンスヘッダーを簡単に追加できます
  • 会社名などのカスタム変数をライセンステキストに含めることができます
  • プラグインは多くの異なる著作権ライセンスヘッダーをサポートしています
  • Javaソースファイルに限らず、すべてのタイプのソースファイルに著作権ヘッダーを追加できます

4. 結論

この記事では、著作権ライセンスヘッダーをソースファイルに追加する2つの異なる方法を学びました。

Eclipse Copyright Generator プラグインは、著作権ヘッダーを追加するための最も簡単で柔軟な方法です。

唯一の欠点は、ファイルの作成後に適用する必要があることです。コードテンプレートでは、各ファイルの作成時に著作権ヘッダーが追加されます。