ActionScriptコーディングガイドライン

Flash

どちら様のblogで紹介されていたのか失念してしまったのですが、AS2APP様のところでご紹介されていた、自社で規定しているMXMLとActionScript 3.0のコーディングガイドラインなるものを、ざっくりと読ませていただきました。僕も見習えるところは積極的に取り入れて、せめてカタチだけでも綺麗なコーディングができればいいなと思います。

以下ActionScriptのコーディングガイドラインについて、個人的に気になった箇所の抜粋です。僕の対訳が間違っている可能性もあるので、ご興味のある方はこちらの本家のドキュメントをご覧ください。
【ファイル編成】

  • importステートメントは、アスタリスクを使用せず、完全修飾名を使用すること。ただし同一パッケージ内から多数のクラスを使用する場合はこの限りではない。
  • importするパッケージはアルファベット順で列挙すること。
  • ゲッター、セッター、あるいはActionScriptのget、set関数で操作する変数はアンダースコア(_)で始める。

【変数宣言】

  • スコープが異なる場合でも、既に他のブロック内で使用されている変数名は使用しない。

【括弧（）と中括弧{}】

  • 関数名と始まりの括弧の間にはブランクを挿入しない。
  • 括弧内では引数の前後にブランクを挿入しない。

【switch、case】

  • default内では常にbreakも記述する。これは通常不要だが（開発者の？）意図を理解する手助けとなる。
  • breakが不必要なcase内では、その旨をコメントで記しておくこと。
  • case内でreturnを使用する場合は、breakを記述する必要はない。

【ネーミング】

  • インターフェース名は必ず"I"で始めること。
  • 関数名は動詞で始めること。
  • イベントから呼ばれる関数名は"Handler"で終わること。
  • ブール型の変数名は"can"、"is"、"has"のいずれかで始めること。

【その他の慣例】

  • 可能ならば（スタティック）定数を使用すること。
Right:
myButton.addEventListener(MouseEvent.CLICK, myHandler);

Wrong:
myButton.addEventListener("click", myHandler);
  • 型定義にはなるべく具体的な型を用いること。
Right:
private function mouseMoveHandler(event:MouseEvent):void

Wrong:
private function mouseMoveHandler(event:Event):void