コメント - project5j

コメント

　１．クラス
　　<summary>から始まり</summary>で終わるNDoc(*)形式を採用する。
　　クラスやインターフェイスなどを継承している場合は<remarks>から始まり</remarks>で終わるNDoc形式を採用する。
　　　例：///<summary>
　　　　　///概要
　　　　　///</summary>
　　　　　///<remarks>
　　　　　///このクラスはProject5j.Bomberman.Class1を継承している。
　　　　　///</remarks>
　　　　　public class Class2 : Project5j.Bomberman.Class1 {
　　　　　}

　２．メンバ
　　<summary>から始まり</summary>で終わるNDoc形式を採用する。
　　　例：///<summary>
　　　　　///概要
　　　　　///</summary>
　　　　　object _objectName;

　３．プロパティ・インデックス
　　<value>から始まり</value>で終わるNDoc形式を採用する。
　　getアクセサを実装している場合は「取得する」と記述して、setアクセサを実装している場合は「設定する」と記述する。
　　　例：///<value>
　　　　　///値を取得する。
　　　　　///</value>
　　　　　object ObjectName {
　　　　　　get {
　　　　　　　return _object;
　　　　　　}
　　　　　}

　　　　　///<value>
　　　　　///値を取得・設定する。
　　　　　///</value>
　　　　　object ObjectName {
　　　　　　get {
　　　　　　　return _object;
　　　　　　}
　　　　　　set {
　　　　　　　_object = value;
　　　　　　}
　　　　　}

　４．メソッド
　　<summary>から始まり</summary>で終わるNDoc形式を採用する。
　　　例：///<summary>
　　　　　///概要
　　　　　///</summary>
　　　　　///<param name="obj1">オブジェクト１</param>
　　　　　///<return>戻り値の説明</return>
　　　　　public object methodName(object obj1) {
　　　　　}

　５．メソッド内部
　　いかなる場合でも、半角スペースを前後に使用した/* ... */を採用する。
　　　例：/* 処理１ */
　　　　　・・・
　　　　　/*
　　　　　 * 処理１
　　　　　 * ここんところをこう、こう、こう。
　　　　　 */

(*)NDoc：ソースコードのコメントをXML, HTML形式でのドキュメントに変換するツール。