その他 - onikiri/onikiri2 GitHub Wiki

dst/仕様/コーディング規約/その他.md

ネームスペース

  • 鬼斬の実装は，全てネームスペースOnikiri内におかれる
  • ヘッダ内でusing namespaceを使用するのは禁止
    • includeしたファイル全てに波及してしまい，ネームスペースの意味が無くなるため

ヘッダ

include の名前と順序

基本的にgoogle のスタイルと同様に（http://www.textdrop.net/google-styleguide-ja/cppguide.xml?showone=%E3%82%A4%E3%83%B3%E3%82%AF%E3%83%AB%E3%83%BC%E3%83%89%E3%81%AE%E5%90%8D%E5%89%8D%E3%81%A8%E9%A0%86%E5%BA%8F#%E3%82%A4%E3%83%B3%E3%82%AF%E3%83%AB%E3%83%BC%E3%83%89%E3%81%AE%E5%90%8D%E5%89%8D%E3%81%A8%E9%A0%86%E5%BA%8F）

全てのヘッダは src/ からの相対パスとして include すること

"." や ".." は使用禁止．

include の順序

以下のようにすると，include 先ヘッダで include しているファイルが隠れにくくなるので，各ファイルの依存ヘッダが明確になる

  1. 対応する cpp ファイルのヘッダ
  2. C/C++システムファイル
  3. その他ライブラリのヘッダ
  4. プロジェクト内のその他のヘッダ

その他の規約

  • マクロは原則使用禁止
  • ハードウェアのテーブルはshttlを使用して実現すること
  • コーディング規約ではないけど，コミット時は必ず具体的に何をしたのかログに書くこと

（文責：しおや

⚠️ **GitHub.com Fallback** ⚠️