是否应该在氧气文件前放置包括防护装置

Should Doxygen documentation be placed before include guards?

本文关键字：包括防 装置 文件 氧气 是否      更新时间：2023-10-16

氧气文件应该放在防护罩之前还是之后?在名称空间之前还是在名称空间内部?

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

#ifndef CONTEXT_HPP
#define CONTEXT_HPP
#include <string>    
/**
 * The application context interface.
 */
namespace test {
    class context { ... };
}

头文件氧信息

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

关于名称空间的氧信息

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