Doxygen[关闭]代码的文档位置

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

当没有相关联的头文件时,源文件(*.m)中的文档非常有用:例如,当您对类使用私有类别时。

此外,Doxygen有一些选项,如果某些内容没有或没有足够的文档记录,这些选项将打印一些警告。

这里有一个链接到一个叫做 Documenting Objective-C with Doxygen .

您的注释通常属于.h文件,因为人们会通过这些文件来了解如何使用您的类。

Here

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

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

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