IDEA設定ドキュメントのコメント

IDEA設定ドキュメントのコメント

1.参考資料

1. IDEAクラスおよびメソッドアノテーションテンプレート設定（非常に詳細）
2. アイデアコメントテンプレートの構成（吐血を推奨!!!）

2.クラスドキュメントのコメント

2.1、ドキュメント注釈テンプレートを設定します

[ファイルとコードテンプレート]ページでクラスのドキュメントコメントを設定します

/**
 *@ClassName ${NAME}
 *@Description  TODO
 *@Author ${USER}
 *@Date ${DATE} ${TIME}
 *@Version 1.0
 */

2.2、クラスのドキュメントコメントを使用する

注：新しいクラスを作成する場合にのみ、クラスのドキュメントコメントを作成できます

3.インターフェイスのドキュメントノートを設定します

3.1、インターフェイスドキュメント注釈テンプレートを設定します

同様に、[ファイルとコードテンプレート]ページでインターフェースドキュメントのコメントを設定します

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME};#end
#parse("File Header.java")
/**
 *@InterfaceName ${NAME}
 *@Description  TODO
 *@Author Oneby
 *@Date ${DATE} ${TIME}
 *@Version 1.0
 */
public interface ${NAME} {
}

3.2、インターフェースのドキュメントノートを使用する

注：新しいインターフェースを作成する場合にのみ、インターフェースのドキュメント・コメントを作成できます。

4.メソッドドキュメントノート

4.1、メソッドドキュメント注釈テンプレートの設定

1. [ライブテンプレート]で新しいテンプレートを作成します

   

2. デフォルトでは、userという名前の新しいグループが作成されます（名前を変更するのが面倒です）

   1. Abbreviation：*メソッドを入力し、*Enterキーを押してメソッドドキュメントのコメントを表示する方法
   2. 説明：メソッドのドキュメントコメントを追加します
   3. テンプレートテキスト：テンプレートコンテンツ
   4. Javaで適用可能：Javaファイルでのみ有効

   

3. テンプレートの変数にデフォルト値を追加します

   

4. メソッドドキュメントのテンプレート

   ** 
    * @description: $description$
    $params$
    * @return: $returns$
    * @author Oneby
    * @date: $date$ $time$
    */ 
   

5. paramsのdefault value：

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

4.2、メソッドのドキュメントノートを使用する

いいね~~~