11

我尝试使用 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
4

2 回答 2

23

是的...

截至目前，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 格式的文档（！！）我很难设置它，它的格式是非正统的，但如果你等不及三巨头更新，它可能只适合你。

祝你冒险顺利。

ZR

于 2014-10-11T01:16:17.740 回答
0

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

于 2021-09-08T15:08:58.350 回答