【问题标题】:How to create documentation for instance variable and methods in Xcode?如何在 Xcode 中为实例变量和方法创建文档?
【发布时间】:2012-01-06 17:14:25
【问题描述】:

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

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

如何做到这一点?在这种情况下,我想知道assets 到底是什么意思

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

【问题讨论】:

    标签: objective-c xcode documentation-generation appledoc


    【解决方案1】:

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

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

    【讨论】:

    • 这很酷!这无助于从 Xcode 中访问信息,是吗?
    【解决方案2】:

    您可能需要查看 Apple 在 Documentation Sets 上的文档以及他们在 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。数字信用应该在那里,因为如果不是他的回答,我不会费心去研究这个。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 2021-05-16
      • 1970-01-01
      • 2011-10-21
      • 2016-06-04
      • 2017-07-03
      • 2013-12-05
      • 2011-08-27
      • 2014-03-06
      相关资源
      最近更新 更多