在哪里使用 Doxygen 记录代码 [关闭]答案

【问题标题】：Where to document code with Doxygen [closed]在哪里使用 Doxygen 记录代码 [关闭]
【发布时间】：2010-06-01 05:09:08
【问题描述】：

我以前从未为任何 C 风格的代码编写过文档（只写过 asdoc 和 phpdoc）。我一直在查看 Doxygen 来记录我的 Objective-C 代码，但我不确定将 cmets 放在哪里。我应该记录 .h 文件还是应该将 cmets 添加到 .m 文件中？或两者？还有其他推荐吗？

【问题讨论】：

【解决方案1】：

按照惯例，cmets 将放在头文件 (*.h) 中，因为它们大多包含声明并且更易于阅读。

当没有关联的头文件时，源文件 (*.m) 中的文档很有用：例如，当您使用类的私有类别时。

此外，Doxygen 有一些选项，如果某些内容没有或没有足够的文档记录，它们会打印一些警告。

编辑：

这是一个名为 Documenting Objective-C with Doxygen 的教程的链接。

【讨论】：

【解决方案2】：

您的 cmets 通常属于 .h 文件，因为人们查看这些文件是为了弄清楚如何使用您的类。

Here 是一个更深入的示例，说明如何将 Doxygen 专门用于 Objective C

【讨论】：

【解决方案3】：

查看一些项目的 doxygen 文档，了解它们的作用。

http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/ 给我留下了深刻的印象，但我相信你能找到一个做得很好的 Objective-c 项目。

API 文档位于 .h 文件中。您可能有一些值得记录的实现细节，因此在 .m 文件中也会有一些。只是不要重复自己。

避免重复你的代码已经说过的内容。

【讨论】：