如何使用HeaderDoc在Xcode中为SWIFT文件生成HTML文档？

Question

如何使用HeaderDoc在Xcode中为SWIFT文件生成HTML文档？

11

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

这是我的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

- ottorottok

2个回答

0

为了记录Swift框架、库和包，苹果在2021年WWDC上推出了DocC，以生成Xcode中的文档并在Web上托管。但它不会生成HTML。它生成一个可以导出并托管在您网站上的包。请参见此视频了解使用DocC生成文档的基础知识。我还发现了一篇好文章这里帮助我入门。这是Xcode 13的一个功能，因此在撰写本文时仍处于Beta版本。关于如何从在Xcode中生成的.doccarchive包中托管此文档，苹果有一个视频解释如何做到这里，尽管我听说有些人在使用该工具时遇到了一些问题。

- Jav Solo

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- zrubenst · Accepted Answer

是的...

目前，HeaderDoc不能使用headerdoc2html将Swift内联文档转换为HTML文件。您和所有人（包括我自己）都必须遗憾地等待。

其他选择

因此，“大三” iOS代码文档工具是HeaderDoc、AppleDoc和Doxygen。不幸的是，这三个工具均不支持Swift。好消息是：AppleDoc即将推出v3.0，另外两个也可能会更新。AppleDoc是开源的，因此如果您精通编码，可以使其适应您的需求（包括swift和所有jazz）

编辑：

我在AppleDoc的Github页面上发表了评论，并收到了几条回复。主要是，在2014年10月16日，苹果公司将举行一次会议。在这次会议之后，AppleDoc的开发人员将开始向AppleDoc 3.0添加Swift支持，并在某个时候发布。

说到Jazz

Jazzy是一种现成的工具，可以生成Swift的HTML文档（!!）。我花了很长时间来设置它，它的格式也不太适应，但如果您不能等待大三更新，那么它可能适合您。

祝您的冒险好运。

ZR