我希望能够将Alt-Click
实例变量(或方法)作为我创建的程序的一部分,并阅读它的目的。
事实上Xcode告诉我类变量被声明为 - 很好但不够。在这种情况下,我想看看我输入的自定义文本来描述asset
究竟是什么。另外,ivar的类型也很有用。
如何才能做到这一点?在这种情况下,我想知道assets
究竟是什么意思
我特别想知道这些信息是否可以从qazxsw poi内部查看,类似于qazxsw poi如何显示qazxsw poi内容。
您需要为项目创建文档集并将其安装在Xcode中。 Xcode
可以帮助你。这是一个命令行工具,可以通过标题中特殊格式的注释生成Apple风格的文档。您还可以使用运行脚本构建阶段将其集成到构建过程中,以便文档始终是最新的。
对于小型项目,通常不值得付出努力,你可能最好只是在头文件中添加注释并使用Cmd-click跳转(Ctrl + Cmd +左箭头返回到你来自的地方)。
您可能想看看Apple关于Eclipse
的文档以及他们关于JavaDoc
的文章。后者基于Xcode 3.x,所以它的相关程度有点值得怀疑,但是看看它是个好主意。
也就是说,如果您决定使用Doxygen(像HeaderDoc这样的替代品可以用于文档,但是我不确定在创建文档集时可以使用哪些内容),看起来主要的一点是你想要的将appledoc扔进你的Doxyfile(或你决定称之为的任何东西)。之后,您只需将结果输入Documentation Sets(根据Doxygen的文档)。我不知道这是否适用于Xcode 4.x - 它值得一试,并且很高兴听到它。
注意:大部分是基于Barry Wark的generating doc sets using Doxygen。图中的信用是由于那里,因为我不打算看这个不是他的回答。