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

Question

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

Xcode 告诉我类变量在 - 声明的事实很好，但还不够。在这种情况下，我希望看到我输入的自定义文本来描述asset真正的内容。此外，了解 ivar 的类型也很有用。

如何才能做到这一点？在这种情况下，我想知道我到底是什么意思assets

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

Answer 1

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

对于小型项目，通常不值得付出努力，您最好只在头文件中添加注释并使用 Cmd-click 跳转到那里（Ctrl+Cmd+向左箭头返回到您来自的位置）。

Answer 2

您可能需要查看 Apple 关于文档集的文档以及他们关于使用 Doxygen 生成文档集的文章。后者是基于 Xcode 3.x 的，所以它的相关性多少有些疑问，但还是看看是个好主意。

也就是说，如果您决定使用 Doxygen（诸如 HeaderDoc 之类的替代品可用于文档，但我不确定就创建文档集而言您可以使用什么），看起来重点是您想要扔进GENERATE_DOCSET=YES你的 Doxyfile （或任何你决定叫它的名字）。之后，您只需将结果放入~/Library/Developer/Shared/Documentation/DocSets（根据 Doxygen 的文档）。我不知道这是否适用于 Xcode 4.x - 不过值得一试，很高兴听到它的回复。

注意：其中大部分是基于Barry Wark 的这个答案。数字信用应该在那里，因为如果不是因为他的回答，我不会费心去研究这个。