在哪里用Doxygen记录代码

Question

我以前从未编写过任何C风格代码的文档（仅执行asdoc和phpdoc）。我一直在寻找Doxygen来记录我的Objective-C代码，但我不确定在哪里发表评论。我应该记录.h文件还是应该将注释添加到.m文件中？或两者？还有其他建议吗？

Answer 1

作为惯例，注释将放在头文件（* .h）中，因为它们主要包含声明，并且更容易阅读。

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

此外，Doxygen有一些选项可以打印一些警告，如果某些东西没有或没有足够的记录。

修改

以下是指向Documenting Objective-C with Doxygen的教程的链接。

Answer 2

您的评论通常属于.h文件，因为这些是人们查看如何使用您的课程。

Here是如何使用Doxygen专门用于Objective C

的更深入的例子

Answer 3

查看一些项目的doxygen文档，看看他们做了什么。

http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/让我印象深刻，但我相信你能找到一个做得好的客观项目。

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

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