提问人：queeg 提问时间：10/22/2023 最后编辑：queeg 更新时间：10/23/2023 访问量：42
Doxygen 注释 - 在标题中还是在实现中？
Doxygen comments - in header or implementation?
问：
我想用 Doxygen 记录一个 Objective C 项目。目的是为开发人员提供文档。整个项目是开源的，所以任何人都可以看到。
我创建了一个 Doxyfile，在运行 Doxygen 1.9.5 后，我可以看到一些（通用）输出。目前为止，一切都好。
现在我想增强文档。在写注释时，我不确定它们应该在 .h（头）文件还是 .m（模块）文件中。
他们应该去哪里？有什么区别？如果我在两面都记录，会发生什么？
答：
0赞
queeg
10/23/2023
#1
所以我发现了一些显着的差异。如果我忽略了一些重要的东西，请告诉我。
当我创建一个主题（使用 和 ）时，我想知道为什么我的一些评论不会出现在小组中。好吧，注释在 .m 文件中。\defgroup\ingroup
- 将它们复制到 .h 文件（并添加来自标题的提示）后，该组确实包含预期的引用，但两个注释都是可见的。
- 然后我删除了提示，使两条评论相同。doxygen 输出的重复消失了。
- 然后我从.m文件中删除了那个，很高兴。
标题中的评论似乎在他们需要去的地方得到了更好的传播。
编辑：我发现一些类的标题在.m文件中。也许不是最佳实践，但事实证明，在声明（标头）中拥有文档比在实现中更好。
评论
.h.m