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

Question

我希望能够Alt-Click 实例变量(或方法)作为我创建的程序的一部分，并阅读它的用途。

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

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

到底是什么意思

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

Answer 1

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

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