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

Question

我希望能够将Alt-Click一个实例变量(或方法)作为我创建的程序的一部分,并阅读它的目的.

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

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

我特别想知道这些信息是否可以从内部查看Xcode,类似于Eclipse节目JavaDoc内容.

Answer 1

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

对于小型项目,通常不值得付出努力,你可能最好只是在头文件中添加注释并使用Cmd-click跳转(Ctrl + Cmd +左箭头返回到你来自的地方).