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

ActionScript 2.0 の学習 > ActionScript 2.0 のベストプラクティスとコーディング規則 > ActionScript シンタックスのフォーマット > 一般的なフォーマットのガイドライン

一般的なフォーマットのガイドライン

スペース、改行、およびタブインデントを使用してコードに空白を追加すると、コードが読みやすくなります。空白を使用すると、コードの階層構造を示すことができ、読みやすさが向上します。読みやすく理解しやすい ActionScript 2.0 コードにすることは、学習者だけでなく、複雑なプロジェクトで作業している経験豊富なユーザーにとっても重要です。コードの読みやすさは、ActionScript コードをデバッグする際にも重要です。コードが正しくフォーマットされ、適切な間隔で配置されていれば、エラーを簡単に突き止めることができます。

ActionScript 2.0 コードでは、同じ内容にも複数の記述方法があります。違いが生じるのは、ActionScript エディタ ([アクション] パネルまたはスクリプトウィンドウ) で複数の行にわたるシンタックスの記述方法に関する部分です。たとえば、ブラケット ({}) や丸かっこ [()] については何とおりかの配置方法があります。

ActionScript コードの読みやすさを向上するためのポイントは次のとおりです。

• ActionScript の段落 (モジュール) 間に 1 行分の空白行を空けます。 

  ActionScript コードの段落とは、論理的に関係しているコードの集まりです。段落間に 1 行分の空白行を空けることで、ActionScript コードを読むユーザーはロジックを理解しやすくなります。

• コードの階層構造を示すために、コード内では一貫したインデントを使用します。 

  ActionScript コード全体で同一のインデントスタイルを使用し、中カッコ ({}) の位置を適切に揃えるようにしてください。中カッコの位置が揃うと、コードが読みやすくなります。正しい ActionScript シンタックスを使用していれば、Enter (Windows) または Return (Macintosh) を押すと自動的にコードの正しいインデントが設定されます。また、ActionScript エディタ ([アクション] パネルまたはスクリプトウィンドウ) で [自動フォーマット] ボタンをクリックすると、シンタックスが正しければ ActionScript コードのインデントが調整されます。

• 改行を使用して複雑なステートメントを読みやすくします。

  条件ステートメントなど、ステートメントによっては、いくつかの形式でフォーマットできます。場合によっては、1 行ではなく複数行にわたってステートメントをフォーマットする方が読みやすくなります。

• キーワードと後続のカッコ [()] の間にスペースを 1 つ入れます。

  その例を次の ActionScript コードに示します。

  do {
      // 処理
  } while (condition);
  

• メソッド名と後続の括弧との間には、スペースを入れないようにします。

  その例を次の ActionScript コードに示します。

  function checkLogin():Boolean {
      // ステートメント;
  }
  checkLogin();
  

  または

  printSize("size is " + foo + "\n");
  

• 引数リストでは、カンマの後ろにスペースを 1 つ入れます。

  次の例に示すように、カンマの後ろにスペースを入れることで、メソッドの呼び出しとキーワードを簡単に区別できます。

  function addItems(item1:Number, item2:Number):Number {
      return (item1 + item2);
  }
  var sum:Number = addItems(1, 3);
  

• 個々の演算子とオペランドの間はスペースで区切ります。  

  次の例に示すように、スペースを入れることで、メソッドの呼び出しとキーワードを簡単に区別できます。

  // よい例
  var sum:Number = 7 + 3;
  // よくない例
  var sum:Number=7+3;
  

  このガイドラインの例外としては、ドット (.) 演算子があります。

• 単項演算子とオペランドの間には、スペースを入れないようにします。 

  たとえば、インクリメント (++) やデクリメント (--) は次の例のように記述します。

  while (d++ = s++)
  -2, -1, 0
  

• 左カッコの後と右カッコの前にはスペースを入れないようにします。 

  その例を次の ActionScript コードに示します。

  // よくない例
  ( "size is " + foo + "\n" );
  // よい例
  ("size is " + foo + "\n");
  

• ActionScript コードを読みやすくするには、1 行に 1 つのステートメントのみを書くようにします。 

  その例を次の ActionScript コードに示します。

  theNum++;       // 正解
  theOtherNum++;  // 正解
  aNum++; anOtherNum++;  // これは誤り
  

• 代入ステートメントの埋め込みは行わないようにします。 

  SWF ファイルで実行時のパフォーマンスを改善するためにステートメントの埋め込みが行われることがあります。しかし、パフォーマンスの改善効果以上にコードの読みやすさが大きく低下し、デバッグが困難になります。その例を次の ActionScript コードに示します。ただし、実際のコードでは、単一文字の名前は避けてください。

  var myNum:Number = (a = b + c) + d;
  

• 変数は別個のステートメントとして代入します。 

  その例を次の ActionScript コードに示します。ただし、実際のコードでは、単一文字の名前は避けてください。

  var a:Number = b + c;
  var myNum:Number = a + d;
  

• 演算子の前で改行します。
• カンマの後ろで改行します。
• 次の行を、前の行の式の先頭に揃えます。

  メモ

  自動インデントおよびインデント設定を制御するには、[編集]-[環境設定] (Windows) または [Flash]-[環境設定] (Macintosh) を選択し、[ActionScript] タブを選択します。

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

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

コメントの追加