コーディングスタイル

命名規則

• ファイル名
  • UpperCamelCase.cpp （原則）
  • lowercase.cpp （一部例外）
• typedef型名
  • snake_case_t （そのときの気分で適当に決める）
  • UpperCamelCase（クラスや構造体の場合）
• クラス／構造体名
  • UpperCamelCase
• 関数名
  • lowerCamelCase （原則）
  • snake_case （時々）
  • UpperCamelCase （Windows用）
• メンバ変数名
  • snake_case
• ローカル変数名
  • snake_case
  • lowercase （そのときの気分で適当に決める）
  • ローカル変数名には原則として大文字を使わない
• ラムダ式名
  • auto UpperCamelCase = [](){}; （原則）
  • auto lowerCamelCase = [](){}; （時々）
• enum型名
  • UpperCamelCase
• enumメンバ
  • UpperCamelCase（原則）
  • UPPER_SNAKE_CASE（時々）
• プリプロセッサシンボル
  • UPPER_SNAKE_CASE （原則）
  • UpperCamelCase （時々）

接頭辞・接尾辞・ハンガリアン記法

接頭辞やハンガリアン記法は採用しない。

クラス名

• 先頭に特定の文字を付ける様なクラス名にはしない。

class CHoge {
};

変数名

• m_ や g_ の様なものは付けない。

class Hoge {
private:
    int m_value;
};
Hoge g_hoge;

• アンダースコアで終わる。（とりあえず不問。将来のリファクタリング対象）

class Hoge {
private:
	int value_;
};

接頭辞

• 禁止はしないが積極的には使わない。
• 状況次第、あった方がいいと判断すれば使う。

bool fCondition;
char *pSomething;

接尾辞

• 状況次第、あった方がいいと判断すれば使う。

char *dataptr;
std::shared_ptr<Hoge> hoge_ptr;

絶対厳禁

• Windows由来のシステムハンガリアン記法は厳禁

char *lpszText;

インデントと空白と改行

• ハードタブ
• 4文字幅を推奨

桁揃え

• 行先頭のインデントだけハードタブ、それ以外の桁揃えは空白文字を使う。

	switch (n) {
	case 1:    return "a";    // comment
	case 12:   return "ab";   // comment
	case 123:  return "abc";  // comment
	}

if

	if (cond1) {
		// do something
	} else if (cond2) {
		// do something
	} else {
		// do something
	}

• 開き括弧の前に1個の空白を入れる。
• 閉じ括弧と波括弧の間に1個の空白を入れる。波括弧の前で改行はしない。
• elseの前後で改行しない。
• 条件式が読みにくいとき、わざと if ブロックで何も行わず else ブロックを利用することがある。

読みにくい

	if (c != 'a' && c != 'b' && c != 'c') {
		// do something
	}

良い

	if (c == 'a' || c == 'b' || c == 'c') {
		// nop
	} else {
		// do something
	}

while

	while (cond) {
		// do something
	}

• 開き括弧の前に1個の空白を入れる。
• 閉じ括弧と波括弧の間に1個の空白を入れる。波括弧の前で改行はしない。

do while

	do {
		// do something
	} while (cond);

• 波括弧の前に1個の空白を入れる。改行はしない。
• 閉じ波括弧の後に1個の空白を入れる。
• 開き括弧の前に1個の空白を入れる。
• セミコロンの前に空白は入れない。

for

	for (int i = 0; i < 10; i++) {
		// do something
	}

• 開き括弧の前に1個の空白を入れる。
• セミコロンの前に空白は入れない。後に1個の空白を入れる。
• 閉じ括弧と波括弧の間に1個の空白を入れる。波括弧の前で改行はしない。

switch

• switchとcaseのインデントは同じ深さとする。

良い

	switch (n) {
	case 1:
		// do something
		break;
	}

良くない

	switch (n) {
		case 1:
			// do something
			break;
	}

通り抜け

• 意図的に break しないときは、fallthruなどのコメントを書く。

	switch (n) {
	case 1:
		// do something
		break;
	case 2: // fallthru
	case 3:
		// do something
		break;
	}

式

• セミコロンの前に空白を入れない。
• 開き括弧の後と閉じ括弧の前に空白を入れない。
• 二項演算子の前後に1個の空白を入れる。
• 単項演算子の後に空白を入れない。

良い

hoge();

良くない

hoge() ;

良い

int n = (12 + 34);

良くない

int n = ( 12+34 );

良い

bool g = !f;

良くない

bool g = ! f;

カンマ

• カンマの前に空白は入れない。後に1個の空白を入れる。

hoge(a, b, c);

式

代入

• 条件式内で変数への代入は行わない。

良くない

	while ((c = get()) != 0) {
	}

例外

	if (Hoge *hogeptr = dynamic_cast<Hoge *>(baseptr)) {
	}

変数宣言

• ポインタや参照の記号（* や &）は変数名の側に寄せる。

良い

char *p;

良くない

char* p;

長い文

• 途中で改行しない。
• 論理的に一行のものは物理的にも一行で記述する原則。
• 一行の長さに制限は設けないので、長くなっても構わない。
• どうしても改行しないと読みにくい場合は、慎重に検討する。

良い

	if (!CreateProcessW(0, &tmp[0], 0, 0, TRUE, CREATE_NO_WINDOW, 0, 0, &si, &pi)) {
	}

良くない

	if (!CreateProcessW(0, &tmp[0], 0, 0, TRUE,
						CREATE_NO_WINDOW, 0, 0, &si, &pi)) {
	}

条件式

• true、false、nullptrなどの定数シンボルとの比較は行わない。
• 定数と比較する場合は、比較する主体の変数を左辺に書き、値を右辺に書く。

良い

	bool f;
	if (f) {
	}
	if (!f) {
	}

良くない

	bool f;
	if (f == true) {
	}
	if (f == false) {
	}

厳禁

	bool f;
	if (true == f) {
	}
	if (false == f) {
	}

良い

	char *p;
	if (p) {
	}
	if (!p) {
	}

良くない

	char *p;
	if (p != nullptr) {
	}
	if (p == nullptr) {
	}

厳禁

	char *p;
	if (nullptr != p) {
	}
	if (nullptr == p) {
	}

良い

	int n;
	if (n == 42) {
	}

厳禁

	int n;
	if (42 == n) {
	}

良い

	if (c >= '0' && c <= '9') {
	}

原則避ける

	if ('0' <= c && c <= '9') {
	}

関数

• 宣言は原則として一行で書く。
• 関数定義の開き波括弧の前に改行する。
• どうしても引数が長くなりすぎるときは、引数を構造体にまとめて、そのポインタを渡すような方法を検討する。

良い

void hoge(int arg1, int arg2, int arg3)
{
}

できるだけ避ける

void hoge(int arg1,
		  int arg2,
		  int arg3)
{
}

厳禁

void
hoge(int arg1, int arg2, int arg3) {
}

要検討

struct HogeArgs {
	int arg1;
	int arg2;
	int arg3;
};
void hoge(HogeArgs *args)
{
}

ポインタ引数

• 参照型の引数に代入しない。引数経由で値を返す場合はポインタを使用する。参照を使うときは必ずconstにする。
• 引数に構造体を渡す場合、ポインタにするかconst参照にするかは問わない。

良い

void func(int *v)
{
	*v = 123;
}

厳禁

void func(int &v)
{
	v = 123;
}

良い

void func(Hoge *hoge)
{
}

厳禁

void func(Hoge &hoge)
{
}

良い

void func(Hoge const *hoge)
{
}

良い

void func(Hoge const &hoge)
{
}

const

• とにかく積極的にconstを使う。
• ポインタはconstが原則。
• どうしてもconstにできないものだけconstを外す。
• 参照型は全てconstにする。 非const参照を使うくらいならポインタにする。
• クラスメンバ関数はできるだけconst関数。

class Hoge {
	int getValue() const
	{
		return value;
	}
};

• range-based-for 等で非const参照を受け取る場合はやむを得ない。

  std::vector<Hoge> hogevec;
  for (Hoge &hoge : hogevec) {
  	// do something
  }

• constの位置、 char const * と書くか、 const char * と書くかは不問。

名前空間

• ヘッダファイルに using namespace を書かない。
• すべてのヘッダファイルをインクルードし終わった後 using namespace を書いて良い。
• using namespace std; は禁止。
• namespaceの波括弧内はインデントしない。
• namespaceの終了波括弧の後に、コメントで名前空間名を書く。

namespace ns1 {
namespace ns2 {

class Hoge {
};

}} // namespace ns1::ns2

pimplイディオム

クラスが大きくなってきたら、pimplイディオムの採用を検討する。ポインタは m を推奨。

Hoge.h

class Hoge {
private:
	struct Private;
	Private *m;
public:
	Hoge();
	~Hoge();
];

Hoge.cpp

struct Hoge::Private {
};

Hoge::Hoge()
	: m(new Private)
{
}

Hoge::~Hoge()
{
	delete m;
}

クラスメンバ関数内で、pimplイディオム以外の用途で m という変数を使用することを避ける。

ライブラリ

• cin、cout、cerr、および、<iostream>系のクラスは使用禁止。