ASDoc タグ

参照されている場所から ASDoc コメントをコピーします。メインの記述、@param および @return の内容がコピーされ、他のタグはコピーされません。

通常は、@copy タグを使用して、宛先クラスの継承リストに含まれないソースクラスまたはインターフェイスから情報をコピーします。ソースクラスまたはインターフェイスが継承リストにない場合は、代わりに @inheritDoc タグを使用します。

ASDoc コメントの @copy タグの前に内容を追加できます。

@see タグと同じシンタックスを使用して場所を指定します。詳細については、@see タグの使用を参照してください。

プロパティ、スタイル、またはエフェクトのデフォルト値を指定します。@default タグを検出すると、ASDoc ツールは次の形式で文を自動的に作成します。

[Event] メタデータタグのコメントには最初の形式を使用します。イベントに関連付けられたイベントオブジェクトの Event.type プロパティの値を定義する定数を指定します。ASDoc ツールは、イベント定数の説明を参照クラスにコピーします。

定数定義のコメントには 2 番目の形式を使用します。定数に関連付けられたイベントの名前を指定します。タグを省略すると、ASDoc は定数のコメントを参照クラスにコピーできません。

詳細については、エフェクト、イベント、およびスタイルの文書化を参照してください。

スタイルプロパティを適用し、見出しを生成し、コード例を正しい場所に置きます。コードを <listing version="3.0"></listing> タグで囲みます。

空白の形式が保持され、コードは灰色の水平のスクロールボックスに表示されます。

このタグは、@example タグにより参照される外部ファイルの例の ASDoc コメントで使用します。ASDoc コメントは、この例の最初の行の前か、例の最後の行の後になければなりません。

外部ファイル例は、コードの例の前の 1 つのコメントと、コード例の後の 1 つのコメントをサポートしています。

このタグは、オーバーライドされたメソッドまたはプロパティのコメントで使用します。スーパークラスからサブクラスにコメントをコピーするか、サブクラスによって実装されたインターフェイスからコピーします。

メインの ASDoc コメント、@param、および @return の内容がコピーされ、他のタグはコピーされません。コメントの @inheritDoc タグの前に内容を追加できます。

このタグを入れると、ASdoc は次の検索順序を使用します。

1. 現在のクラスによって実装されたインターフェイス (特定の順序はなし) と、そのすべての基本インターフェイス。

2. 現在のクラスの直接のスーパークラス。

3. 直接のスーパークラスのインターフェイスと、そのすべての基本インターフェイス。

4. Object クラスに達するまでステップ 2 および 3 を繰り返します。

@copy タグを使用することもできますが、@copy タグは、サブクラスの継承チェーンに含まれないソースクラスまたはインターフェイスから情報をコピーするためのものです。

生成された出力のタグに接続されているテキストを非表示にします。非表示のテキストは内部コメントに使用できます。

メソッドパラメータに説明のコメントを追加します。paramName 引数は、メソッドシグニチャのパラメータ定義に一致していなければなりません。

生成された出力からエレメントを除外します。

クラス全体を省略するには、@private タグをそのクラスの ASDoc コメントに入れ、1 つのクラスエレメントを省略し、@private タグをそのエレメントの ASDoc コメントに入れます。

指定されたテキストを使用して、メソッドの説明に Returns セクションを追加します。ASDoc は、戻り値
のデータ型を自動的に決定します。

クラスエレメントへのリンクを使用して、見出し "See Also" を追加します。詳細については、@see タグの使用を参照してください。

メソッドがスローする可能性があるエラーを文書化します。