Question

考虑我有2个头文件。

// HEADER 1
/**
 * Doc  for Foo here?
 */
namespace Foo {
  class This {...};
}

＆安培;＆安培;

// HEADER 2
/**
 * Doc for Foo here?
 */
namespace Foo {
  class That {...};
}

使用Doxygen记录时应该如何处理？

Answer 1

也许两者都没有。

例如，假设您有"<root>/utility/header1.hpp"，其内容位于namespace utility和"<root>/utility/header2.hpp"，也可以。{/ p>

您可以添加一个文件："<root>/utility.hpp"，用于记录实用程序命名空间。您可以将其置于顶部#error Documentation only.，以确保它不会被意外包含在内。

但我建议至少制作一些偏僻的文件，以使其保持在理智的位置（并且不会随机地与某些类混合。）

Answer 2

找到文档的最佳位置，无论是在其中一个文件还是其他文件中。使用带有Doxygen命名空间标记的注释块：

/**
 * @namespace Foo
 * Documentation for Foo here. More docs for Foo here,
 * and down here.
 */