[記述すべき] インクルードガード
インクルードガードの記述例
|
1 2 3 4 5 6 |
#ifndef FOO_H #define FOO_H /* 中略 */ #endif /* FOO_H */ |
インクルードガードを記述すべき背景
ヘッダファイルの中から、さらに別のヘッダファイルをインクルードすることで、一つのヘッダファイルが２回以上インクルードされるときがある。インクルードガードが記述されていないと同一の定義や宣言が２回以上、１つの翻訳単位（～.cファイル）の中に現れてコンパイルエラーが生じるため。
define名に関する補足
接頭辞にアンダースコアを２回重ねたシンボル名は予約語です。 次のようなdefine定義名はシステム（コンパイラなど）の予約語と重複する可能性があります。予約語と衝突する不適切なdefine名の例： __FOO_H__
[記述すべき] 外部結合するグローバル変数の宣言
外部結合の例
|
1 2 3 |
extern int number_of_record; extern int list_of_record[]; extern const char name[]; |
|
1 2 3 |
int number_of_reservation = 0; int list_of_record[255] = {0, }; const char name[255] = "Alice"; |
|
1 2 3 4 5 6 7 8 9 10 11 12 |
#include "foo.h" number_of_reservation = 0; /* ... 中略 ... */ int list_of_record[i] = 0; /* ... 中略 ... */ const char* user_name = name; |
[記述すべきでない] 内部結合するグローバル変数の宣言や定義
内部結合するグローバル変数の適切な記述位置
|
1 |
static const char name[255] = "Alice"; |
内部結合するグローバル変数の不適切な記述位置
|
1 |
static const char name[255] = "Alice"; |
初期化を記述することでグローバル変数の宣言ではなく定義になります。複数の定義が存在するとリンクエラーが発生するため窮余の一策（不適切な回避策）としてstatic宣言をしています。結果として名前が重複するstaticグローバル変数が複数の翻訳単位に存在する特異な状況が生じます。
[記述すべきでない] モジュール外部に公開しない関数のプロトタイプ宣言
関数のプロトタイプ宣言は省略せずに必ず記述しましょう。プロトタイプ宣言の記述を省略しても、たまたまコンパイルが成功することはありますが、一旦コンパイルが成功しても、その後のコード修正でプロトタイプ宣言のないコードのコンパイルが失敗することがあるため、かならずソースファイルの先頭、もしくはヘッダファイルに関数のプロトタイプ宣言を記述しましょう。
関数プロトタイプ宣言は必ずどこかに記述する。しかし、モジュール外（xxx.cの外部、xxx.oの外部）からアクセスする必要のない static な関数のプロトタイプ宣言をヘッダファイルに記述してはいけません。 *.c ファイルの先頭に記述しましょう。