個人用C++スタイルガイド

これは個人用のC++スタイルガイドである. 現時点で自分にとって最も混乱を引き起こさない命名規則, 及びCMakeを前提として拡張性があるディレクトリ構造を目指す.

これを作る理由

今までEmacsを使ってC++のプログラムを書いてきたが, デフォルトの補完機能は貧弱である. やはりチェッカーでシンタックスチェックを行いながらプログラムを書きたいので, rtagsを使うようになった. rtagsを使うにはプロジェクトのコンパイルコマンドが記されたcompile_commands.jsonが必要であるので, 自然とCMakeを利用してビルドするようになった.

クラスのメソッドのコードを書く際は, メンバ変数を区別するために末尾にアンダーバーを付けたり, 始めにm_を付けたりと色々と試してきたが, _mMemberVariableの形式にするのが一番わかり易いと感じた. Class(memberVariable) : _memberVariable(MemberVariable) {}のようにして仮引数と区別を付けるためである. またメンバ関数はlower-camel, クラス名はupper-camelにすることが経験的に多い. またオブジェクトの初期化にコンストラクタだけでは不十分であることが多い(遅延初期化などもあるので). そのためinitialize()みたいなメソッドを持たせるのが良い.

一旦今までの傾向をまとめておきたい.

ディレクトリ構造

以下の感じが今の所ベスト. llvmのレポジトリを参考にしている. 共通部分はすべてライブラリにまとめ, main()を含むものだけをsrc/runtime.cppに書いていく. テストツールにはgtestを使う.

├── .clang-format
├── .travis.yml
├── CMakeLists.txt
├── README.md
├── cmake
│   ├── FindEigen3.cmake
│   ├── gtest.cmake
│   └── pybind11.cmake
├── examples
├── include
│   └── project_name
│       ├── lib1
│       │   ├── lib1_header1.h
│       │   └── lib1_header2.h
│       └── lib2
│           ├── lib2_header1.h
│           └── lib2_header2.h
├── lib
│   ├── lib1
│   │   ├── lib1_source1.cpp
│   │   └── lib1_source2.cpp
│   └── lib2
│       ├── lib2_source1.cpp
│       └── lib2_source2.cpp
├── src
│   ├── runtime1.cpp
│   └── runtime2.cpp
└── test
    └── CMakeLists.txt

CMakeLists.txtでincludeをinclude_directoriesに指定すれば, #include <project_name/lib1/lib1_header1.hが通るようになる.

コード例

namespace CppStyle{

class ClassDefinition{
public:
    // static member
    // begin with 's'
    static int sEntityCounter = 0;
    
private:
    // member variables
    // begin with 'm'
    // and later UpperCamel form
    T1 _memberOne;
    T2 _memberTwo;
    T3 _memberOther;
    
public:
    // getters
    inline T1 getMemberOne() const { return _memberOne; }
    inline T2 getMemberTwo() const { return _memberTwo; }
    inline T3 getMemberOther() const { return _memberOther; }
    inline void setMemberOne(T1 arg) { _memberOne = arg; }
    inline void setMemberTwo(T2 arg) { _memberTwo = arg; }
    inline void setMemberOther(T3 arg) { _memberOther = arg; }

public:
    ClassDefinition();
    virtual ~ClassDefinition();
    
    // lowerCamel form
    void someFunc1();
    void someFunc2();
    T otherFunc();
};


} // namespace CppStyle