適切なコメントの書き方

ActionScript 2.0 コード内で一貫性のあるコメントを使用すると、コメントがなければ不明確になる複雑なコード領域や重要なインタラクションに説明を付けることができます。コメントは、コードの目的を明確に説明する必要があり、コードを単に翻訳したようなものであってはなりません。コードを一見しただけでわからない内容があれば、そこにコメントを追加してください。

コードで自動フォーマットツールを使用すると、後続コメント (後続コメントを参照) が次の行に移動することがわかります。このようなコメントはコードをフォーマットした後に追加することができます。さもなければ、自動フォーマットツールを使用した後でコメントの新しい位置を変更する必要があります。

クラス内でのコメントの使用の詳細については、クラスへのコメントの追加を参照してください。

コードにコメントを追加するときは、次のガイドラインに従ってください。

コメントが複数行にわたる場合はブロックコメント (/* と */) を使用し、短いコメントには単一行コメント ( // ) を使用します。
また、必要に応じて、ActionScript コードと同じ行に記述する "後続コメント" も使用できます。
ActionScript コードを単に翻訳したようなコメントは使用しないようにします。
ActionScript コードを読めばわかるエレメントにコメントを付ける必要はありません。
コードを一見しただけでわからないエレメントには、コメントを付けます。
特に、主題が前後の段落に記述されていない場合は、コメントを追加してください。

雑然としたコメントは使用しないようにします。

雑然としたコメント行には、よく等号 (=) やアスタリスク (*) が含まれています。代わりに、空白を使ってコメントと ActionScript コードを区切ります。

メモ

自動フォーマットツールを使用して ActionScript をフォーマットすると、空白が削除されます。その場合は空白を追加し直すか、空白を維持するための単一行コメント (//) を使用します。このようなコメント行は、コードをフォーマットした後で簡単に削除できます。

プロジェクトを展開する前に、余分なコメントをコードから削除します。

ActionScript コード内のコメントが多くなった場合は、そのコードの一部を書き直す必要がないか検討してください。ActionScript コードの動作に関して多くのコメントを残す必要があると感じる場合、それは通常、ActionScript コードの書き方が良くないことの現れです。

メモ

読者に教えることが目的の ActionScript コードの中では、コメントの使用が最も重要です。たとえば、Flash の教育目的でサンプルアプリケーションを作成する場合や、ActionScript コードのチュートリアルを作成する場合には、コードにコメントを追加します。

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

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