CrossFramework/コード規約 のバックアップ差分(No.1)

• バックアップ一覧
• 現在との差分 を表示
• 現在との差分 - Visual を表示
• ソース を表示
• バックアップ を表示
• CrossFramework/コード規約 へ行く。
  • 1 (2011-02-19 (土) 21:52:26)
  • 2 (2011-02-19 (土) 22:56:46)
  • 3 (2011-02-19 (土) 22:56:46)
  • 4 (2011-02-20 (日) 21:36:46)
  • 5 (2012-05-26 (土) 23:25:40)

• 追加された行はこの色です。
• 削除された行はこの色です。

* コード規約 [#m8a05d57]
#contents
** C++ [#wc6ececc]
:hpp|
#code(c,){{
/**
 * @file
 * @brief このファイルに対する説明。
 * @author ファイル作成者名。
 */
#if defined(モジュール名_INCLUDED_大文字ファイル名_HPP)
#else
#define モジュール名_INCLUDED_大文字ファイル名_HPP

//-----------------------------------------------------------
// インクルードするものがあればここに記述。
// システムヘッダインクルード(abc順) -> 通常ヘッダインクルード(abc順) の順番。
#include <XBase/Matrix34.hpp>
#include <XBase/Vector3.hpp>
#include "app/EntryPoint.hpp"

//-----------------------------------------------------------
namespace モジュール名 {

    // ・クラスなどシンボルを記述する場合原則は1ヘッダ1クラス。
    // ・他のヘッダとぶつかる可能性があるため関数をnamespace直下に書いてはいけない。
    // 　structやclassのstatic関数として記述する。
    // ・ユーザーが直接触ることがないシンボルに対するコメントはdoxygenスタイルで書いてはいけない。
    // ・doxygenコメントで使用してよいタグリスト。
    // @code @endcode @n @e @ref
    // 以下のものはこの順番で記述すること。
    // @copydoc
    // @brief
    // @return
    // @param
    // @see
    // @details

    /// クラスに対する説明
    class Class
    {
    public: // public,protected,privateの順番。
        // 非インスタンスシンボル -> インスタンスシンボルの順番。
        // 1. enum / class /struct /typedef 
        // 2. static変数
        // 3. static関数
        // 4. インスタンス変数
        // 5. コンストラクタ・デストラクタ
        // 6. インスタンス関数

        // doxygenのグルーピング機能は使用禁止。
        // シンボルはabcの名前でsortしたいため。

        // 型の名前は

    private:
        // 定義順はpublicと同じ。
    };

}
//-----------------------------------------------------------
}}