是否应该在包含防护装置之前放置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信息放在记录的元素之前。