c++ - Should Doxygen documentation be placed before include guards?

Question

Should Doxygen documentation be placed before or after include guards; before or inside a namespace?

Assume the header contains the declaration of a single class (context) and this is what I am documenting here.

#ifndef CONTEXT_HPP
#define CONTEXT_HPP

#include <string>    

/**
 * The application context interface.
 */
namespace test {
    class context { ... };
}

Answer 1

ヘッダー ファイルに関する Doxygen 情報

上司が特に言わない限り、インクルード ガードの前後どちらにコメントを入れても問題ありません。それはすべて、あなた (およびあなたのチーム) の個人的な好みに依存します。私は通常、それらをファイルの先頭に置きます。

名前空間に関する Doxygen 情報

これは少し異なります。この場合、誰かがヘッダーを読み取ったときに明確になるため、常に名前空間の前に配置する必要があります。ドキュメント化された要素の前に、常に doxygen 情報を配置する必要があります。