IntelliJ IDEAでのJavaソースファイルの著作権ライセンスヘッダーの追加

1. 概要

このチュートリアルでは、IntelliJ IDEAプロジェクトファイルにライセンスヘッダーを追加する方法を見ていきます。 通常、ライセンスヘッダーには、プロジェクトファイルで許可されている使用法と所有権が記述されています。
link:/intellij-basics[IntelliJの基本的な知識]を持っていることを前提としています。そのため、すぐに説明します。

2. ライセンスヘッダーの設定

既存のプロジェクトを開いて、ライセンスヘッダーを設定しましょう。 まず、IntelliJ IDEAメニュー項目をクリックするか、Command +コンマキーを押して、_Preference_ウィンドウにアクセスする必要があります。
新しいポップアップウィンドウの左側にメニューのリストが表示されます。このリストから、_Editor_> _Copyright_> _Copyright Profiles_をクリックできます。 より迅速にアクセスするために、設定ウィンドウの検索バーに「_Copyright_」と入力するだけです。
ウィンドウの右側のペインで、上部の「+」ボタンをクリックして、新しい著作権プロファイルを作成します。
まず、名前に_MIT License_、たとえば_—_を付けて、[OK]をクリックします。
link:/uploads/Screenshot-2019-03-03-at-6.43.52-PM-100x73.png%20100w []
この後、ライセンステキストをテキスト領域に追加します。
最終的には独自のものに置き換える必要があるサンプルテキストを使用しました。
link:/uploads/Screenshot-2019-03-03-at-7.00.58-PM-100x73.png%20100w []
  • _ <YEAR> をプレースホルダー- $ today.year ._ *に置き換えました。プロファイルを使用するたびに、IntelliJによって現在の年に自動的に変換されます。

    IntelliJは、著作権プロファイルで使用できる追加の変数を定義します。 詳細については、https://www.jetbrains.com/help/idea/copyright-profiles.html [ヘルプページ]をご覧ください。
    最後に、ライセンステキストのすぐ下にある[検証]ボタンをクリックしてテキストを検証し、すべてが正しいことを確認してから、[適用]をクリックしてプロファイルを保存します。
    次に、プロファイルをデフォルトのプロファイルとして設定します。 _Editor_> _Copyright_をクリックして、デフォルトのプロジェクトの著作権としてMITライセンスを選択することで、これを実現できます。
    link:/uploads/Screenshot-2019-03-03-at-7.12.23-PM-100x73.png%20100w []

3. プロジェクトファイルで作成された著作権プロファイルを使用する

次に、プロジェクトファイルで著作権プロファイルを使用します。 これを実現するには、Ctrl + Returnキーを押して、著作権メニューを選択します。
link:/uploads/Screenshot-2019-03-04-at-7.28.52-AM-100x64.png%20100w []
これにより、以前にデフォルトとして設定した著作権テキストがプロジェクトファイルの最上部に適用されます。
結果のテキストの形式に満足できない場合は、_Preferences_> _Editor_> _Copyright_> _Copyright Profiles_に移動して編集し、「適用」をクリックします。 その後、既存のテキストをクリアし、Ctrl + Returnキーを押して、更新されたテキストを適用する必要があります。
その後、作成する新しいプロジェクトファイルにはライセンスヘッダーが自動的に追加されるため、手動で追加する必要はありません。

4. 結論

この簡単な記事では、IntelliJ IDEAを構成して、すべてのプロジェクトファイルにライセンスヘッダーを自動的に追加する方法を学びました。これは、より大きなコードベースで非常に便利です。