日食

JAutodocガイド



Jautodoc Guide



Jautodocは、主にJavadocとファイルヘッダーをソースコードファイルに自動的に追加するために使用されるEclipseプラグインです。それは使用しています 速度 テンプレート テンプレートを作成し、要素名に基づいて対応するコメントを生成します。

特性



Jautodocには次の主な機能があります。





モード

既存のJavadocの完了：既存のJavadocは変更または上書きされません。それらは、まだ文書化されていない欠落しているタグと要素のみを追加します

既存のJavadocを保持する：既存のJavadocは変更または上書きされません。欠落しているタグは追加されませんが、以前に文書化されていなかった要素は文書化されません



既存のJavadocを置き換える：既存のJavadocは、生成されたJavadocに置き換えられます。このオプションの使用には注意してください。

二。 可視性

  • パブリック、保護、パッケージ、またはプライベート
    対応する可視性階層のプロパティを定義して、Javadocを作成できます。

3.フィルター

  • コメントタイプ、フィールド、メソッド、またはゲッター/セッターのみ
    どのタイプのクラスメンバーがJavadocを作成できるかを判別できます。

4.オプション

  • 自動生成されたJavadocのToDoタグを追加します
    目的は、自動生成されたJavadocを含むすべてのソースファイルを簡単に見つけられるようにすることです。各ソースファイルで1回だけ生成されます。

要素名に基づいてコメントを作成する
このオプションを設定すると、Jautodocは以下に示すように要素名に基づいてコメントを生成します。テンプレートは、生成形式とその生成方法を定義できます。さらに、メソッド、フィールドの場合、パラメーターの省略形は「置換」で定義されます。

フィールド：



方法：


単一行フィールドコメント：

1行コメントを作成するオプション。



Eclipseのコメントを使用したフォーマット
Eclipseに付属のフォーマットツールを使用して、生成されたコメントをフォーマットできます。対応するフォーマットスタイルは、プリファレンスで設定できます。


フィールドゲッター/セッターアノテーション
フィールドアノテーションに基づいてゲッター/セッターアノテーションを作成します

ファイルヘッダー

  • ファイルヘッダーの追加/置換
    まだヘッダーがない場合は、ソースファイルに追加するヘッダーを定義できます。既存のファイルヘッダーを置き換えることを選択できます。 「複数のコメントヘッダー」をチェックすることにより、ソースファイルの先頭にある複数のコメントを置き換えることができます。 Velocityテンプレート言語はヘッダーテキストで使用できます VII ）および事前定義された変数。



注：ヘッダーテンプレート内でドル記号（たとえば、SVN / CVS属性$ id $）を使用するには、エスケープ文字（ $）でエスケープする必要があります。

パッケージJavadoc

  • テンプレートを編集する

package.htmlまたはpackage-info.javaの初期コンテンツを定義できます。パッケージエクスプローラーで渡すことができます ビューで適切なパッケージノードを選択し、[パッケージJavadocの追加]を選択します。



・ヘッダーコメントと同様に、テンプレートでVelocityテンプレート言語を使用できます。 VII ）および事前定義された変数。

  • package-info.javaを使用します
    使用package-info.java代わりにpackage.html

交換

要素名に基づいてコメントを作成する場合、メソッド、フィールド、またはパラメーターの一部の代わりに別のテキストを使用できます。たとえば、「set」は「Sets」に置き換えられ、「db」は「Database」に展開されます。

これらの選択肢は、設定を通じて追加、削除、および変更できます。置換範囲は、フィールド、メソッド、またはその両方にすることができます。フィールド範囲を使用する場合、フィールドとパラメーターに適用されます。デフォルトでは、プレフィックスまたは頭字語のみが置き換えられます。

注：頭字語では大文字と小文字は区別されません。 ショートカットでは大文字と小文字は区別されません。単語の最初の文字を大文字にすることで、間隔（setDbNameなど）を検出します。

  • オープンソースファイル用のJavadocは、すべてのメンバーまたは指定されたメンバーにコメントを追加できます。この場合、変更されたメタファイルは自動的にハードディスクに保存されません。

    カーソルがフィールドまたはメソッド宣言内にある場合、この要素のみを文書化できます。カーソルがフィールドまたはメソッドの宣言内にある場合、この要素のみが文書化されます。型注釈を作成するには、型名を指します。それ以外の場合は、現在のソースファイルのすべてのメンバーが文書化されます。

・「...」でメニュー項目を選択すると、[オプション]ダイアログが開き、設定を上書きして以前の設定を上書きできます。これらの設定は、現在のコンパイルユニットに対してのみ有効であり、Eclipseセッションに対してのみ有効です。


  • に パッケージエクスプローラー 表示モードでは、1つ以上のソースファイルを選択してJavadocを追加できます。 Javadocを追加するために、1つ以上のソースファイルを選択できます。または、パッケージを選択してJavadocをパッケージのすべてのメンバーに追加することも、プロジェクト全体で使用することもできます。
    警告： エディタで開かれていないソースファイルは、ディスクに直接保存されます。

オプションダイアログを使用すると、すべての変更をプレビューできます。


タスク検索

Jautodocを使用すると、Javadoc、ヘッダー、または特別なタグがないタスク設定を検索できます。

ほとんどのオプションは非常に明確です。いくつかのオプションは次のとおりです。

  • 生成されたJavadoc
    生成されたJautodocコメントと完全に一致するJavadocコメントを検索します。
  • 期限切れのファイルヘッダー
    生成されたJautodocヘッダーと一致しないヘッダーを検索します
  • 不足しているタグを検索する
    @authorなどの欠落しているタグを検索します。タグ名の後にマイナス記号が追加された場合、情報のない既存のタグはプロンプトまたは追加されません。ただし、タグ名の後にプラス記号を追加すると、メッセージなしで既存のタグのプロンプトが表示されます。 （例：説明なしで@deprecated）。