Doxygen 文档是否应该放在包括警卫之前？ [关闭]答案

【问题标题】：Should Doxygen documentation be placed before include guards? [closed]Doxygen 文档是否应该放在包括警卫之前？ [关闭]
【发布时间】：2013-05-24 06:47:19
【问题描述】：

Doxygen 文档应该放在包括警卫之前还是之后？在命名空间之前或内部？

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

#ifndef CONTEXT_HPP
#define CONTEXT_HPP

#include <string>    

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

【问题讨论】：

文件文档应该出现在包含守卫之前，其他在文档元素（命名空间、类、方法等）之前。
他们不会破坏应用程序的构建吗？换句话说，在包含和编译之前是否删除了 cmets？
注释是cmets，对编译没有影响。
@g-makulik 为什么在包含警卫之前？它可能会为预处理器做更多的工作。
@g-makulik 他们对预处理器也没有影响吗？

标签： c++ documentation doxygen

【解决方案1】：

有关头文件的 Doxygen 信息

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

有关命名空间的 Doxygen 信息

这有点不同，在这种情况下，您应该始终将它们放在命名空间的前面，因为这样在有人阅读标题时会更清楚。您应该始终将 doxygen 信息放在文档元素之前。

【讨论】：