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

Question

我希望能够将Alt-Click实例变量（或方法）作为我创建的程序的一部分，并阅读其目的。

事实上Xcode告诉我类变量被声明为 - 很好但不够。在这种情况下，我希望看到我输入的自定义文本来描述asset到底是什么。此外，ivar的类型也很有用。

如何做到这一点？在这种情况下，我想知道assets

究竟是什么意思

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

Answer 1

您需要为项目创建文档集并将其安装在Xcode中。 appledoc可以帮助您解决此问题。这是一个命令行工具，可以通过标题中特殊格式的注释生成Apple风格的文档。您还可以使用运行脚本构建阶段将其集成到构建过程中，以便文档始终是最新的。

对于小型项目，它通常不值得付出努力，你可能最好只是在你的头文件中添加注释并用Cmd-click跳转到那里（Ctrl + Cmd +左箭头回到你来的地方）从）。

Answer 2

您可能希望查看有关Documentation Sets的Apple文档以及有关generating doc sets using Doxygen的文章。后者基于Xcode 3.x，所以它的相关程度有点值得怀疑，但是看看它是个好主意。

那就是说，如果你决定使用Doxygen（像HeaderDoc这样的替代品可以用于文档，但是我不确定在创建文档集时你可以使用什么），看起来主要的一点是你'我想把GENERATE_DOCSET=YES扔进你的Doxyfile（或你决定调用的任何东西）。之后，您只需将结果输入~/Library/Developer/Shared/Documentation/DocSets（根据Doxygen的文档）。我不知道这是否适用于Xcode 4.x - 它值得一试，而且很高兴听到它。

注意：大部分内容都是基于Barry Wark的this answer。图中的信用是由于那里，因为我不打算调查这不是他的回答。