コード規約 Edit

C++ Edit

hpp
すべてを展開すべてを収束 
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
!
|
!
 

/**
 * @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と同じ。
    };
 
}
//-----------------------------------------------------------
    ホーム 一覧 検索 最終更新 バックアップ リンク元   ヘルプ   最終更新のRSS