このページでは、『Adobe Flex 3.3 リファレンスガイドActionScript 3.0 コンポーネントリファレンスガイド』で使用する表記規則について説明します。

表記規則

本リファレンスガイドでは、次の表記規則を使用しています。

• Italic font（イタリックフォント）は、特定の値に置き換えられる値を表します。
• Bold font（ボールドフォント）は、言語エレメントを表します。
• Code font（コードフォント）は、コード例またはテキスト内の言語エレメントを表します。
• ActionScript では、コメントの前にスラッシュを 2 つ（//）付けます。
• ActionScript では、スラッシュおよびアスタリスク（/*...*/）を使用して、コメント行の始まりと終わりを表します。
• MXML では、<!-- および --> の文字を使用して、コメント行の始まりと終わりを表します。
• コード内の数値の範囲は、0..59 のように表します。

メモ：コード例では、長いコード行が読みやすいように改行されている場合があります。サンプルコードをコピーおよびペーストして、エラーが発生した場合は、長いコード行に改行が含まれていないかどうかを確認してください。

クラス API の表示

API は、一般的な API ドキュメントの形式で表されますが、ActionScript 言語を理解しやすいように、次のような変更を行っています。

• パッケージ項目には、クラスが属するパッケージを記載しています。
• クラス項目には、クラスとその属性を記載しています。
• 継承情報には、継承パスと継承エレメントを記載しています。継承は 2 種類の矢印で表します。
  • クラスの説明の最上部にある継承項目では、クラスが継承するスーパークラスを右向きの矢印で表します。
  • パブリックプロパティおよびパブリックメソッドのセクションでは、別のクラスから継承されるプロパティまたはメソッドの左側に上向きの矢印を記載しています。
• 実装項目には、クラスが実装するインターフェイスを記載しています。
• サブクラス項目には、このクラスから継承されるクラスを記載しています。
• パブリックメソッドの一覧では、コンストラクタを最初のメソッドとして記載し、以降のメソッドをアルファベット順に記載しています。

© 2009 Adobe Systems Incorporated. All rights reserved.
Thu Mar 19 2009, 09:00 PM -07:00