Adobe Flex 3 ヘルプ

@see タグの使用

@see タグを使用すると、クラス内部のエレメント、同じパッケージ内の他のクラスのエレメント、および他のパッケージに対するクロス参照を作成できます。また、ASDoc 外部の URL もクロス参照できます。@see タグのシンタックスは次のとおりです。

@see reference [displayText]

reference はリンク先を指定し、displayText はリンクテキスト（省略可能）を指定します。@see タグの参照先は、reference 属性のプレフィックスによって決まります。

  • # ASDoc は、同じクラスでリンク先を探します。
  • ClassName ASDoc は、同じパッケージのクラス内でリンク先を探します。
  • PackageName ASDoc は、別のパッケージでリンク先を捜します。
  • global ASDoc は、最上位のパッケージでリンク先を探します。
  • style ASDoc は、リンク先のスタイルプロパティを探します。

注意: reference 内に HTML タグを挿入することはできません。ただし、ASDoc コメント内に HTML コードを挿入することによって、@see タグを使用せずに HTML リンクを追加することはできます。

次の表に、@see タグの例をいくつか示します。

例

結果
@see "Just a label"

テキスト文字列
@see http://www.cnn.com

外部 Web サイト
@see package-detail.html

ローカル HTML ファイル
@see Array

最上位クラス
@see AccessibilityProperties

同じパッケージ内のクラス
@see flash.display.TextField

別のパッケージ内のクラス
@see Array#length

最上位クラスのプロパティ
@see flash.ui.ContextMenu#customItems

別のパッケージ内のクラスのプロパティ
@see mx.containers.DividedBox#style:dividerAffordance

別のパッケージ内のクラスのスタイルプロパティ
@see #updateProperties()

@see タグと同じクラスのメソッド
@see Array#pop()

最上位クラスのメソッド
@see flash.ui.ContextMenu#clone()

別のパッケージ内のクラスのメソッド
@see global#Boolean()

最上位のパッケージメソッド（グローバル）
@see flash.util.#clearInterval()

flash.util のパッケージメソッド

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート