Skip to content

CxxCodingRule

Sora Shiratani edited this page Sep 21, 2023 · 4 revisions

Todo Group C++ Cording Rule / 藤堂研C++コーディング規約

ファイル名

  • 全て小文字が基本。必要に応じてアンダースコアを用いて良い
  • ソースファイル: file_name.cpp
  • ヘッダファイル: file_name.hpp
  • ヘッダファイル名は、その中で定義されているクラス名をそのまま使う

インデント

  • 適切にインデントする
  • 基本はスペース2文字
  • 同じプロジェクトに含まれるファイルのインデントは、統一したルールでインデントする

行数

  • 一つの関数のコード行数は30行を超えないように
  • 長過ぎるコードは適宜リファクタリングする

ヘッダファイル

  • 適切にインクルードガードを付ける
  • namespaceの中でファイルをincludeしない
  • ヘッダ毎に最低一つのテストプログラムを書く

includeの順序

  1. コード自身に対応するヘッダファイル
  2. Cシステムファイル
  3. C++システムファイル
  4. その他ライブラリのヘッダファイル
  5. プロジェクトのヘッダファイル

コメント

  • (少なくともcommitの段階では)コードはコメントアウトせず、削除する