コーディング規約

ヘッダファイル
スコープ
クラス
命名規約
コメント

ヘッダファイル

#define ガード

ヘッダファイルには #define ガードを入れる。

#define ガードのシンボル名は、 <PROJECT>_<PATH>_<FILE>_H_ という書式にする。

例:foo というプロジェクトの foo/src/bar/baz.h というファイル場合

#ifndef FOO_BAR_BAZ_H_
#define FOO_BAR_BAZ_H_

...

#endif  // FOO_BAR_BAZ_H_

-inl.hファイル

複雑なインライン関数を定義するときには、必要に応じて -inl.h というサフィックスを持つファイルに書いても構わない。

関数パラメータの順序

関数を定義するときには、パラメータの並び順を「入力、出力」という順序にすること。

インクルードの名前と順序

コードを読みやすくするため、また、依存関係が隠れてしまうのを避けるため、インクルードを次の順序にすること。 Cライブラリ、C++ライブラリ、その他のライブラリの .h、プロジェクトの .h

プロジェクトのヘッダファイルはすべて、プロジェクトのソースディレクトリ配下にあるものとして書くべきだ。UNIXディレクトリのショートカットである .（カレントディレクトリ）や ..（親ディレクトリ）を使ってはいけない。例えば、 google-awesome-project/src/base/logging.h をインクルードするときには、以下のようにする。

#include "base/logging.h"

dir/foo.cc の主たる目的が dir2/foo2.h にあるものを実装もしくはテストすることであれば、dir/foo.cc では次の順序でヘッダをインクルードする。

dir2/foo2.h （適切なところ ― 詳しくは下を参照）。
Cシステムファイル
C++システムファイル
その他ライブラリの .h ファイル
プロジェクトの .h ファイル

ここで推奨している順序にしておくと、依存関係は隠れにくくなる。私たちはすべてのヘッダファイルが、それ自身でコンパイルできるようにしたい。いちばん簡単な方法は、すべてのヘッダファイルを .cc でインクルードする最初の .h にしておくことだ。
dir/foo.cc と dir2/foo2.h は同じディレクトリに置くことが多い。（例えば、base/basictypes_unittest.cc と base/basictypes.h）。しかし、別のディレクトリに置いても構わない。
セクション内では、アルファベット順にインクルードするとよい。
例えば、google-awesome-project/src/foo/internal/fooserver.cc のインクルードは次のようになる。

#include "foo/public/fooserver.h"  // 適切なところ

#include <sys/types.h>
#include <unistd.h>

#include <hash_map>
#include <vector>

#include "base/basictypes.h"
#include "base/commandlineflags.h"
#include "foo/public/bar.h"

印刷する

カテゴリ：
学問・理系
総合

コーディング規約 - メタのお勉強先頭へ

Menu

エディタ

クラウドIDE

XML

チャット

オープンソース

エンドツーエンド暗号化

プロジェクト管理

フォーラム

ソースコードの管理

GitClient

ホスティング

開発手法

ドメイン駆動設計:DDD?

テスト駆動開発:TDD

ビヘイビア駆動開発:BDD

チケット駆動開発：TiDD

課題追跡システム:ITS(issue tracking system)

バグ追跡システム:BTS(bug tracking system)

ビルドツール

JavaScript

ビルドファイルを自動生成

設定ファイル

データシリアライズ

スキーマレス

マルチフォーマット

参考

継続的インテグレーション

オススメ

OSS用

for Windows

OSS

その他

構成管理

テストツール

デプロイツール

仮想マシン構築

オーケストラレーション

仮想化ソフトウェア

仕様

クラスタリソースマネージャ

コンテナオーケストレーション

サービスメッシュ

Kubernetes

高可用性クラスタ/HAクラスタ

負荷分散/ロードバランス（Load Balancing）クラスタ

HPC(High Performance Computing)クラスタ

テスト

Ruby on Rails

JavaScript,TypeScript

Living Documentation Generator

ドキュメント作成

reStructuredText

CommonMark

JavaScript

DocBook

グラフドキュメント

WIKI

書籍

問い合わせ言語

ファイルシステム

分散型Web

Web API作成補助ツール

モック作成

フォーマット

パッケージ管理システム

Ruby

Chef

OCaml

Rust

Web Frontend

Node.js

Haxe

Microsoft .NET Framework

Windows

Mac OS X

Debian

Red Hat系

Gentoo Linux