IDEA は Java クラスメソッドのアノテーションテンプレートを構成します

1. クラスアノテーションテンプレート

[ファイル] -> [設定] -> [エディタ] -> [ファイルとコードテンプレート] -> [ファイル] で
クラス、インターフェイス、列挙型などを選択すると、パブリッククラスの上の右側の領域に #parse("File Header .java")

このコードでは、クラスインターフェイス、列挙型、および作成したその他のファイルのコメントとして File Header.java ファイルが導入されています。では、このクラスはどこにあるのでしょうか? Files の右側に、include オプションがあることがわかります。さまざまなテンプレートを定義し、必要に応じてこのテンプレートを導入できます。File Header.java テンプレートがクラスファイルに導入されています。その後、このテンプレートを設定したいものに変更できます。

画像-20220512152855134

カスタム注釈テンプレート

/**
 * @className: ${NAME}
 * @author: Kevin
 * @date:  ${DATE}
 **/

新しいインターフェイスファイルは自動的にコメントを生成します。その効果は次のとおりです。

/**
 * @className: CrowdService
 * @author: Kvein
 * @date: 2022年05月12日 15:33:00
 **/
public interface CrowdService {
    
    
}

注釈テンプレートの不完全な変数参照テーブル

事前定義された変数	説明
${名前}	現在のファイルの名前
${PACKAGE_NAME}	新しいファイルが作成されるパッケージの名前
${ユーザー}	現在のユーザーのシステムログイン名
${日付}	現在のシステム日付
${TIME}	現在のシステム時間
${年}	今年
${月}	今月
${MONTH_NAME_SHORT}	現在の月名の最初の 3 文字。例: 1 月、2 月など。
${MONTH_NAME_FULL}	現在の月のフルネーム。例：1月、2月など
${日}	今月の現在の日
${DAY_NAME_SHORT}	現在の日付の名前の最初の 3 文字。例：月、火など
${DAY_NAME_FULL}	今日のフルネーム。例：月曜日、火曜日など
${時間}	現在の時間
${分}	現在の分
${PROJECT_NAME}	現在のプロジェクトの名前

2. メソッドアノテーションテンプレート

ファイル -> 設定 -> エディタ -> ライブテンプレート

1. Live Templates の右側にある + 記号をクリックしてテンプレートグループを追加し、methodTemplates という名前を付けます。

2. 次のように、作成したばかりの MethodTemplates の下に Live Templates を作成します。

1). 位置 1: テンプレートの略語コードを入力します。
位置 2: テンプレートの説明を入力します。
位置 3: メソッドコメントテンプレートのスタイルを入力します。可変変数の場合は、表す $変数$ $名$ $p a r a m$ ;
このような変数名に設定されていない場合、4 番目の位置をクリックできません。テンプレートは次のとおりです。

/**
 * @title $title$
 * @author Kevin $param$
 * @updateTime $date$ $TIME$ $return$
 * @throws $throws$
 */

位置 4 をクリックします。次のように、定義された変数の値を編集できます。

変数 param はメソッドのパラメータ変数であり、メソッドのパラメータの数に応じて変更する必要があり、変数 return は戻り値の型であり、メソッドの戻り値に応じて変更する必要があります。設定コードは以下の通りなのでコピー＆ペーストしてください。

パラメータ:

groovyScript("def result=''; def stop=false; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(',').toList(); if (params.size()==1 && (params[0]==null || params[0]=='null' || params[0]=='')) { stop=true; }; if(!stop) { for(i=0; i < params.size(); i++) {result +=((i==0) ? '\\r\\n' : '') + ((i < params.size() - 1) ? ' * @param: ' + params[i] + '\\r\\n' : ' * @param: ' + params[i] + '')}; }; return result;", methodParameters())

戻る：

groovyScript("def result=''; def data=\"${_1}\"; def stop=false; if(data==null || data=='null' || data=='' || data=='void' ) { stop=true; }; if(!stop) { result += '\\r\\n' + ' * @return: ' + data; }; return result;", methodReturnType())

[位置 3] で、テンプレートの適用範囲をクリックして選択します。注釈をどこにでも追加できることを示すには、[どこでも] を選択します。

[オプションで展開] をクリックして、このテンプレートで使用するショートカットキー (Tab キー、スペースキー、Enter キーなど) を選択します。

たとえば、ここで設定したテンプレートのキーワードが * で、使用するショートカットキーが Tab キーの場合
、メソッドに * を入力して Tab キーを押すと、テンプレートに従ってコメントが生成されます。

画像-20220512154405338

追加情報

メソッドアノテーションテンプレートはメソッド外では使用できません。メソッド外で使用した場合、@param が取得できず、アノテーションは @param null になります。

クラスアノテーションテンプレートはファイルの作成時に生成され、作成されたファイルはテンプレートをトリガーしませんが、メソッドアノテーションテンプレートはトリガーされます。