Flash CS3 ドキュメンテーション

ActionScript 2.0 の学習 > クラス > 例 : カスタムクラスの記述 > クラスのドキュメンテーション

クラスのドキュメンテーション

クラスやインターフェイスにはドキュメンテーションの観点から、他のユーザーのためにコメントを付けておくことが大切です。たとえば、クラスファイルを Flash コミュニティに配布する場合や、一緒に作業している設計者チームや開発者チームで自分のクラスファイルを使用する場合やプロジェクトの一部として使用する場合などがあります。ドキュメンテーションによって、他のユーザーがクラスの目的などを理解しやすくなります。

典型的なクラスファイルまたはインターフェイスファイルのコメントには、"ドキュメントコメント" と "実装コメント" の 2 種類があります。ドキュメントコメントはコードの仕様を説明するために使用し、実装内容についての説明は含めません。実装コメントは、コードをコメントアウトする目的や、コードの特定の部分の実装について説明を加えるために使用します。この 2 種類のコメントには、異なる区切り記号を使用します。ドキュメントコメントは /** と */ で区切り、実装コメントは /* と */ で区切ります。

ドキュメントコメントは、インターフェイス、クラス、メソッド、およびコンストラクタを説明するのに使用します。クラス、インターフェイス、またはメンバーごとに 1 つのドキュメントコメントを含めてください。ドキュメントコメントは、宣言の直前に配置します。

ドキュメントコメントに適さない追加情報がある場合は、実装コメント (コメントについてに示す形式のブロックコメントまたは単一行コメント) を使用します。実装コメントを記述する場合は、宣言の直後に記述します。

クラスファイルをドキュメント化するには :

1. Flash オーサリングツールで "ClassA.as" および "ClassB.as" を開きます。
2. ClassA クラスファイルを変更し、クラスファイルの先頭に新規コードを追加します (太字の部分を変更します)。

   /**
       ClassA クラス
       version 1.1
       6/21/2005
       著作権 : Adobe Systems Incorporated
    */
   class com.adobe.utils.ClassA {
       private static var _className:String = "ClassA";
   
       public function ClassA() {
           trace("ClassA constructor");
       }
       public function doSomething():Void {
           trace("ClassA - doSomething()");
       }
   }
   

   上記のコードでは、コメントをクラスファイルの先頭に追加しています。クラスの作成者、最終修正日、著作権情報、既知の問題点などを ActionScript ファイルと Flash ファイルにコメントとして記述しておくことは有益です。

3. "ClassB.as" ActionScript ファイルにも、クラス名などを変更して同様のコメントを記述します。
4. 次に進む前に、両方の ActionScript ファイルを保存します。

クラスのコードには、ブロックコメント、単一行コメント、後続コメントも記述することができます。コード内にコメントを記述する方法については、適切なコメントの書き方を参照してください。コメントに関する一般的な情報については、単一行コメント、複数行コメント、および後続コメントを参照してください。

SWF ファイルでのカスタムクラスファイルの使用方法については、例 : Flash でのカスタムクラスファイルの使用を参照してください。

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

現在のページ: http://livedocs.adobe.com/flash/9.0_jp/main/00000794.html

コメントの追加