【问题标题】：How to generate HTML documentation for SWIFT files in Xcode with HeaderDoc?如何使用 HeaderDoc 在 Xcode 中为 SWIFT 文件生成 HTML 文档？
【发布时间】：2014-11-21 13:52:36
【问题描述】：

我尝试使用 HeaderDoc 在 Xcode 中记录我的 Swift 项目，但只处理文件“.h”而忽略文件“.swift”

这是我的快速文件：

/// test
///
/// :param: ann blabla
func testFunc( ann: Foo ) { .. }

我在终端中运行以下命令：

headerdoc2html -o ~/Desktop/docum Ninja

This is the error:

    Documentation will be written to /Users/me/Desktop/docum
    HTML output mode.
    No valid input files specified. 

        Usage: headerdoc2html [-dq] [-o <output directory>] <input file(s) or directory>.

    iMac:MyApp me$  headerdoc2html -o ~/Desktop/docum Ninja/

    Documentation will be written to /Users/me/Desktop/docum
    HTML output mode.
    DIR Ninja/
    ======= Parsing Input Files =======

    Processing Ninja/Test.m
        Skipping. No HeaderDoc comments found.

    Processing Ninja/-Bridging-Header.h

【问题讨论】：

标签： ios shell swift xcode6 headerdoc

【解决方案1】：

是的……

截至目前，HeaderDoc 无法使用 headerdoc2html 将 Swift 内联文档转换为 HTML 文件。您和所有人（包括我自己）将不得不等待。

其他选项

所以“三大”iOS 代码文档工具是 HeaderDoc、AppleDoc 和 Doxygen。遗憾的是，这三个都不支持 Swift。好消息：AppleDoc 即将推出 v3.0，另外两个也可能（可能会）也更新。 AppleDoc 是开源的，所以如果你精通代码，你可以调整它以满足你的需求（使用 swift 和所有爵士乐）

编辑：

我在 AppleDoc 的 Github 页面上发表了评论并收到了几条回复。主要是，2014 年 10 月 16 日苹果正在召开发布会。此次会议结束后，AppleDoc 人员（女性？）将开始为 AppleDoc 3.0 添加 Swift 支持，并将在某个时候发布。

爵士乐

Jazzy 已经出现现在 (!) 并且可以为 Swift 生成 HTML 形式的文档 (!!) 我很难设置它，而且它的格式是非正统的，但如果你等不及三巨头的更新，它可能只适合你。

祝你冒险顺利。

【讨论】：

太棒了，非常感谢！爵士乐对我很有用。 @MohitAthwani - 如果您使用的是 xcworkspace，此评论可能会对您有所帮助：github.com/realm/jazzy/issues/111#issuecomment-67039330
@nathan.f77 我爱你把我指向那个链接...... Jazzy 就像一个魅力！我想知道你是怎么猜到我在使用工作区...
“v3.0 很快” - 究竟是什么让你这么说？从您的帖子发布到现在已经快 4 个月了，没有迹象表明 v3 会很快公开（或可用）。
@LearnCocos2D 4 个月前，我在 Github 上询问了首席开发人员 v3.0 何时发布。他说很快就会发布；它还没有被释放。因此，他对空头的定义要么是半年，要么是他算错了。
现在也很喜欢 Jazzy。

【解决方案2】：

为了记录 Swift 框架、库和包，Apple 在 WWDC 2021 上推出了 DocC 以在 Xcode 中生成文档并在网络上托管。但是，它不会生成 HTML。它会生成一个包，然后可以将其导出并托管在您的网站上。有关使用 DocC 生成文档的基础知识，请参阅 this video。我还找到了一篇很好的文章 here 帮助我入门。这是 Xcode 13 的一项功能，因此在撰写本文时它仍处于测试阶段。关于如何从 Xcode 中生成的 .doccarchive 包托管此文档，Apple 有一个视频解释了如何做到这一点 here 尽管我听说有人在使用该工具时遇到了一些问题。

【讨论】：