株式会社プライムはシステム設計・開発のプロフェッショナル企業です。

・「///」ではじめる。

・適切なXML形式でなければならない。タグには終了タグも必要。「</XXX>」

<summary>

 概要について説明を1行程度で明記する。

<remarks>

 機能仕様について説明を明記する。

<param>

 メソッドに引数がある場合、その引数について説明を明記する。

<return>

 メソッドに戻り値がある場合、その戻り値の説明を明記する。

<exception>

 メソッドにが例外をスローする場合、その例外について説明を明記する。

<example>

 使用方法が難解である場合、コーディングサンプルを明記する。

<value>

 プロパティを実装した場合、そのプロパティの説明を明記する。

上記以外のタグもあるが、適宜、必要なものを記述する。

クラス、およびメソッドの定義が始まる直前にコメント行を配置し、そのクラスの機能概要、外部インタフェースについて記述する。

詳細については「NDoc」のドキュメントを参照のこと。

・１行の文字数を最大80桁とする。

・インデントは空白4文字分とする。その際、タブは使用せず空白文字を使用する。

・１行に複数のステートメント（式）を記述しない。

 （変数定義も同様に、１行１変数の宣言とする）

・不等号の向きは左向き（「<」、「<=」）にする。

 （定数と比較する場合は右向きでも可）

・不等号で使用する定数は右側に配置する。

・カンマの後には空白文字を入れる。

・for文の「;（セミコロン）」の後には空白文字を入れる。

・算術演算子（「+」、「-」、「*」、「/」、「%」）の前後には空白文字を入れる。

・算術演算子（「++」、「--」）とオペランドの間には空白文字を入れない。

・代入演算子（「=」、「+=」、「-=」、「*=」、「/=」、「%=」）の前後には空白文字を入れる。

・比較演算子（「<」、「<=」、「==」、「>」、「>=」、「!=」）の前後には空白文字を入れる。

・条件演算子（「||」、「&&」、「|」、「&」、「^」、「!」）の前後には空白文字を入れる。

・シフト演算子（「<<」、「>>」、「>>>」）の前後には空白文字を入れる。

・ビット演算子（「|」、「&」、「^」、「~」）の前後には空白文字を入れる。

・return文では括弧を使用しない。

 （メソッドでなく式であることを明確にする）

・for文で使用するカウンタはfor文のカウンタ宣言にて行なう。

 （for文の外側で宣言しない）

・for文とwhile文の使用用途を明確にする。

 （カウンタを利用する規則的な繰り返しの場合はfor文、それ以外はwhile文を使用する）

・for文で使用するカウンタの初期値は「0」を基本とする。

 （配列の添字は「0」からである．カウンタはインデックスの役割で使用する場合が多い）

・制御文（「if」、「else」、「while」、「for」、「do while」）での「{}」は省略しない。

 （１行の式でも省略しない．機能追加時のバグ発生を避けられる）

・ローカル変数は利用する直前で宣言する。

 （C言語のように関数の入り口で宣言しない）