名前を付けるガード

Question

C++にはどのような名前のガードが含まれていますか？私はこれをたくさん見る傾向があります：

#ifndef FOO_H 
#define FOO_H 

// ... 

#endif 

しかし、私はそれは非常に直感的ではないと思います。ファイル名を見ることなく、FOO_Hが何であるか、その名前が何を指しているのかを知ることは困難です。

ベストプラクティスとは何ですか？

Answer 1

私の経験からは、ヘッダーファイルの後にインクルードガードに名前を付けることができますが、名前がすべて大文字であり、ピリオドがアンダースコアに置き換えられます。

したがってtest.hはTEST_Hになります。

実際の例としては、クラスヘッダファイルを自動生成するときにこの規則に従うQt Creatorがあります。

Answer 2

私は通常FOO_H_INCLUDED_のようなものを使用します。いくつかの（Microsoftの）ヘッダーは、GUIDの文字列表現によく似ていますが、それほど精巧なものは必要としませんでした。

Answer 3

FOO_HをFOO_H_INCLUDEDに置き換えてください。

Answer 4

通常、ファイル名でファイル名を指定するので、各ファイルのコードはコンパイルされて一度だけ追加されます。あなたはFOO_Hをあなたが望むものにすることができましたが、私が今までにコード化したり見たことのほとんどがファイル名を使用していました。 FOO_Hが他の誰かのFOO_Hと競合しないようにするため、それが一意であることを確認してください。

Answer 5

がgoogle's style guideから直接取得：

すべてのヘッダファイルが複数の混入を防止するために#define ガードを持っている必要があります。 シンボル名の形式は、 にする必要があります。< PROJECT> _ < PATH> _ < FILE> _H_です。 の一意性を保証するには、プロジェクトの ソースツリーのフルパスに基づいて、 にする必要があります。

#ifndef FOO_BAR_BAZ_H_ 
#define FOO_BAR_BAZ_H_ 
... 
#endif // FOO_BAR_BAZ_H_ 

私は自分のプロジェクトでこのスタイルを使用します。たとえば、プロジェクトfooの でファイル のfoo/SRC /バー/ baz.hには、以下のガードを持っている必要があります。

Answer 6

私はいつもそれを見て、それを最後に追加します。つまり、FOO_H_248です。それは余計な予防策です。とにかくそれを覚えておく必要はないので、それは秘密だという事実。他の人が前に述べたよう

Answer 7

は、非常に一般的な慣例は、アンダースコアに置き換え名の大文字バージョン、およびドットを使用することです：foo.hという - > FOO_H

しかし、これは、との名前の衝突につながることができます単純な名前および/または一般的な名前。このため、非空のVisual C C++のプロジェクトのようないくつかのランダムな文字列、追加でstdafx.hをのような自動生成されたヘッダー：

#ifndef FOO_H__NsknZfLkajnTFBpHIhKS 
#define FOO_H__NsknZfLkajnTFBpHIhKS 
#endif 

http://www.random.org/strings/は、このために便利な乱数生成器です。

ファイルは、いくつかのサブモジュールの一部である、またはその内容は一つの特定の名前空間内に存在する場合も、私はあまりにもガードにそれを追加する傾向があります。＃のあなたのヘッダーを含めるコードで

#ifndef SOMECOMPONENT_FOO_H__NsknZfLkajnTFBpHIhKS 
#define SOMECOMPONENT_FOO_H__NsknZfLkajnTFBpHIhKS 

namespace somecomponent 
{ 
    ... 
} 

#endif 

Answer 8

ルック。

それはのようなものである場合：

#include "mylib/myheader.h" 

mylib/myheader.hすでに一意の名前です。 /と大文字と小文字を置き換えてください。あなたのインクルードパスに同じ名前の相対してパスを含めるには2つのヘッダを持っている場合は_

#define MYLIB_MYHEADER_H 

で、あなたはすでにそのレベルでの衝突を持っています。

Answer 9

私は個人的にブーストの推奨に従います。たぶん、これはおそらく、C++ライブラリの中で最も優れたコレクションの一つであり、問​​題はありません。

それはのように行く：

<project>_<path_part1>_..._<path_partN>_<file>_<extension>_INCLUDED 

// include/pet/project/file.hpp 
#ifndef PET_PROJECT_FILE_HPP_INCLUDED 

である：

• 法的（_[A-Z]することにより、その始まりを注意したり__を含むことはできません）
• 一意であることが保証
• を生成しやすいです（インクルードガードとして）（他の場所に2つのファイルがある場合）
（あなたが戦いのために台無しにしている INCLUDEDで別のマクロを終了している場合）、何のために使用されないことが保証210

私はGUIDについて読んだが、それらは奇妙に見えます。

そして、明らかに私はしたいのではなく、すべてのコンパイラは名前が多かれ少なかれ直感的かもしれないが、事実が持つということである