Doxygen 注释 - 在标头或实现中？

Question

我想用 Doxygen 记录一个 Objective C 项目。目的是为开发人员记录。整个项目是开源的，所以任何人都可以查看。

我创建了一个 Doxyfile，在 Doxygen 1.9.5 运行后我可以看到一些（通用）输出。到目前为止一切顺利。

现在我想增强文档。写注释时，我不确定它们应该在 .h（头文件）文件中还是 .m（模块）文件中。

他们应该去哪里？有什么不同？如果我双面记录会发生什么？

Answer 1

所以我发现了一些显着的差异。如果我忽略了一些重要的事情，请告诉我。

当我创建一个主题（使用

\defgroup

和

\ingroup

）时，我想知道为什么我的一些评论不会出现在小组中。嗯，注释在 .m 文件中。

• 将它们复制到 .h 文件（并添加来自标题的提示）后，该组确实包含预期的引用，但两条注释都是可见的。
• 然后我删除了使两条评论相同的提示。 doxygen 输出中的重复消失了。
• 然后我从 .m 文件中删除了该文件，然后就可以开始了。

标题中的评论似乎可以更好地传播到需要去的地方。