如何在Xcode中创建实例变量和方法的文档？

Question

我希望能够在我创建的程序中，通过Alt-Click来查看实例变量（或方法）的用途。尽管Xcode告诉我类变量是在哪里声明的很好，但这还不够。在这种情况下，我想看到我自己输入的自定义文本来描述一个asset的真实含义。此外，知道ivar的类型也很有用。

怎么做呢？在这种情况下，我想知道我所说的assets具体指什么。

我特别想知道是否可以从Xcode内部查看此信息，类似于Eclipse显示的JavaDoc内容。

- James Raitsev

Answer 1

您需要为项目创建文档集并在Xcode中安装它。您可以使用appledoc来帮助您完成这项工作。这是一个命令行工具，可以从您的标头文件中特殊格式化的注释生成符合Apple风格的文档。您还可以将其与运行脚本构建阶段集成，以便始终保持文档最新。

尽管如此，对于小型项目而言，这通常并不值得花费精力，您可能最好只需在标头文件中添加注释并使用Cmd + 单击跳转（Ctrl+Cmd+左箭头返回之前的位置）。

- omz

---

这非常酷！但是这不能帮助从Xcode内部访问信息，对吗？ - James Raitsev

Answer 2

您可能需要查看苹果关于“文档集(Doc Sets)”的文档，以及他们关于使用Doxygen生成文档集的文章。后者基于Xcode 3.x，因此它的相关性有些值得怀疑，但浏览一下是个好主意。

话虽如此，如果您决定使用Doxygen（HeaderDoc等替代方案可用于文档编写，但我不确定在创建文档集方面哪些可用），则似乎主要问题是您将希望在您的Doxyfile文件中添加GENERATE_DOCSET=YES。之后，只需将结果放入~/Library/Developer/Shared/Documentation/DocSets（根据Doxygen的文档）。我不知道这是否适用于Xcode 4.x——不过还是值得一试的，如果能回复一下就太好了。

注意：大多数内容基于Barry Wark的答案。感谢他的答案，否则我就不会去了解这个。

- user457812