1. 概要
このチュートリアルでは、IntelliJIDEAプロジェクトファイルにライセンスヘッダーを追加する方法を見ていきます。 ライセンスヘッダーは通常、プロジェクトファイルの許可された使用法と所有権を記述します。
IntelliJ の基本的な知識があることを前提としているため、要点を簡単に説明します。
2. ライセンスヘッダーの構成
既存のプロジェクトのいずれかを開いて、ライセンスヘッダーを構成しましょう。 まず、IntelliJ IDEAメニュー項目をクリックするか、Command + Commaキーを押して、Preferencesウィンドウにアクセスする必要があります。
新しいポップアップウィンドウの左側にメニューのリストが表示され、そこからエディタ>著作権>著作権プロファイルをクリックできます。 すばやくアクセスするには、[設定]ウィンドウの検索バーにCopyrightと入力するだけです。
ウィンドウの右側のペインで、上部の「+」ボタンをクリックして、新しい著作権プロファイルを作成しましょう。
まず、 MIT License 、たとえば — という名前を付けてから、[OK]をクリックします。
この後、ライセンステキストをテキスト領域に追加します。
サンプルテキストを使用しましたが、最終的には独自のテキストに置き換える必要があります。
交換しましたプレースホルダー付き–$today.year。 プロファイルを使用するたびに、IntelliJによって現在の年に自動的に翻訳されます。
IntelliJは、著作権プロファイルで使用できる追加の変数を定義します。 詳細については、ヘルプページをご覧ください。
最後に、ライセンステキストのすぐ下にある[検証]ボタンをクリックしてテキストを検証し、すべてが正常であることを確認してから、[適用]をクリックしてプロファイルを保存します。
次に、プロファイルをデフォルトとして設定します。 Editor > Copyright をクリックし、デフォルトのプロジェクト著作権としてMIT Licenseを選択することで、これを実現できます。
3. プロジェクトファイルで作成された著作権プロファイルを使用する
次に、プロジェクトファイルで著作権プロファイルを使用します。 これは、Control + Returnキーを押して、著作権メニューを選択することで実現できます。
これにより、以前にデフォルトとして設定した著作権テキストがプロジェクトファイルの最上部に適用されます。
結果のテキストの形式に満足できない場合は、環境設定>エディター>著作権>著作権プロファイルに移動できます。 ]を編集して「適用」をクリックします。 その後、既存のテキストをクリアし、Control+Returnキーを押して更新されたテキストを適用する必要があります。
その後、作成する新しいプロジェクトファイルには自動的にライセンスヘッダーが含まれるため、手動で追加する必要がありません。
4. 結論
このクイック記事では、すべてのプロジェクトファイルにライセンスヘッダーを自動的に追加するようにIntelliJ IDEAを構成する方法を学びました。これは、大規模なコードベースで非常に便利です。