c – 在包含防护装置之前是否应该放置Doxygen文件？

2023年4月13日 189次阅读

是否应在包括防护装置之前或之后放置Doxygen文件;在命名空间之前或之内？

假设标题包含单个类(上下文)的声明,这就是我在这里记录的内容.

#ifndef CONTEXT_HPP
#define CONTEXT_HPP

#include <string>    

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

最佳答案 有关Header文件的Doxygen信息

除非你的老板没有另外说明,否则你是否在包括警卫之前或之后提出意见并不重要.这一切都取决于您(和您的团队)的个人喜好.
我通常把它们放在文件的开头.

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

点赞