Doxygen 文档是否应该放在包含防护之前？

Question

Doxygen 文档应该放在包含防护之前还是之后？在名称空间之前或内部？

假设标头包含单个类 ( ) 的声明context，这就是我在这里记录的内容。

#ifndef CONTEXT_HPP
#define CONTEXT_HPP

#include <string>    

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

Answer 1

有关头文件的 Doxygen 信息

除非你的老板没有另外说明，否则无论你将注释放在包含守卫之前还是之后，都无关紧要。这完全取决于您（和您的团队）的个人喜好。我通常把它们放在文件的开头。

有关命名空间的 Doxygen 信息

这有点不同，在这种情况下，您应该始终将它们放在名称空间前面，因为当有人读取标头时，它会更清楚。您应该始终将 doxygen 信息放在记录的元素之前。