【问题标题】:JavaDoc-like documentation for Objective-C in Xcode? [duplicate]Xcode 中 Objective-C 的类似 JavaDoc 的文档? [复制]
【发布时间】:2011-09-07 17:21:09
【问题描述】:

可能重复:
How to do the documentation in objective C?

是否可以用 Xcode 4 在快速帮助中显示它们的方式在 Objective-C 中编写类/方法文档,和/或以 Apple 自己的文档样式从中生成 doc 文档?

【问题讨论】:

标签: objective-c xcode documentation xcode4 comments


【解决方案1】:

现场展示 - 我不知道。

但至于生成类似 Apple 的文档,我发现最好的是 appledoc,我已经使用了一年了。 If 接受广泛的注释样式,包括 Javadoc 样式,并且可以生成非常像 Apple 的文档,它也可以直接安装到您的 Xcode 帮助系统中。

【讨论】:

  • 找不到404错误!?
  • 我已更新评论以引用 GentleBytes 主页。 Appledoc 可以在那里找到。
【解决方案2】:

我不知道它是否仍然适用于 Xcode 4,但对于 Xcode 3,您可以使用 doxygen 生成 API 文档集。

Apple 有一套分步指南:Using doxygen to Create Xcode Documentation Sets 说明如何操作。

【讨论】:

  • 哇,docSets 看起来像一头大野兽。我认为我不想在我的(目前)单人项目中这样做。我可能会看看 Doxygen。
  • @fzwo:其实很简单。您使用 Doxygen 生成 API 文档,然后有几个额外的步骤来创建 Apple 文档集。这些可以集成到构建过程中。
【解决方案3】:

GitHub 上还提供了 appledoc 工具。制作漂亮的文档集。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2010-10-24
    • 1970-01-01
    • 1970-01-01
    • 2014-11-30
    • 1970-01-01
    • 2011-05-13
    • 1970-01-01
    相关资源
    最近更新 更多