问题标签 [headerdoc]

我们正在使用 headerdoc 为我们的文档创建 html 文件，这些文件将在我们的 Web 框架中呈现为部分。我们想知道是否有一种方法可以阻止 header 文档生成的 html 文件中的 head、html 和 body 标签，因为这些文档将在我们的 Web 模板中呈现。

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

这是我的快速文件：

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

我想知道是否有人可以解释 Xcode 中以下两种注释语法之间有什么/是否有任何区别。

似乎两者都允许 Xcode 将您的评论显示为文档，但我不确定两者之间是否存在差异。

我正在为 iOS 应用程序开发一个可重用的 API 组件。我已经完成了 API 并记录了它以headerdoc供将来的用户使用。

现在我想为这些头文件创建 HTML 页面。所以我在我的项目目录的终端中执行了以下命令

但是没有创建文档，而是出现如下错误：

我尝试了各种方法和方法，最后我缩小了问题范围：

在我的项目开始时，我有类似的东西：

所以问题出在这个特定的评论上，实际上这个评论是由 XCode 自动生成的，我实际上将名称和评论格式修改为headerdoc. 没有日期或日期格式。即使我删除了这些评论，也没有任何效果；得到同样的错误。有人可以帮我解决这个问题吗？

我正在尝试在我自己的文档中添加指向 UIKit 方法的链接。根据这个文档，我应该添加一个@see带有//apple_ref/链接的标签。

这是我的文档：

结果如下：

知道我该怎么做吗？

编辑：同样的问题@see在同一个文件中。

我创建了一个以块为参数的方法。该块需要一些参数，所以我想像 Apple 在他们的具有相似格式的方法中那样缩进文档......

一个简单的例子是：

但很明显，这只会在文档中出现：

我如何获得data并fields显示像 Apple 的方法一样缩进，该方法采用带参数的块？

我在Apple 的 HeaderDoc 文档中找不到如何执行此操作

我在 XCode 中使用 headerDoc 标记，似乎无法在 .m 文件中记录私有方法。直接使用 Apple 网站上的示例语法：

导致以下错误：

@implementation 块之外的 headerDoc 标记可以正常工作而不会出现此错误。

我必须为 Xcode 的项目 Objective-C 生成一个文档。我有一个错误anonymous type。我认为 headerdoc 不喜欢 @interface 部分。有人可以解决吗？

对于一些语法错误，我深表歉意，我有一个 Xcode 的项目 Objective-C，我想生成一个带有脚本的文档（我不在工作，所以我会尝试解释这个问题）。在我的项目中，我有一个类 x

。H

.m

当我运行时，出现“匿名类型”错误，当我删除 .m 中的@interface 部分时，它正在工作。

我正在使用 HeaderDoc 来记录我的代码，并且我想链接到文档中的其他方法。我不想生成 HTML（至少现在是这样），但我确实希望它出现在 Xcode 的右侧面板中。以下是-applicationDidEnterBackground:Xcode 中出现的文档。我想实现那些引用我自己编写的其他方法的蓝色链接：

文档说要使用@link，但它似乎不起作用：

这是我尝试过的：

结果如下：

如您所见，它没有正确渲染。我在这里读到它@link坏了，但评论可以追溯到 2013 年。有修复吗？我做错了吗？

编辑：我尝试了圣诞老人的建议，结果如下：

呈现为：

我正在使用 headerDocs 来记录我的 Xcode 项目。我成功地记录了我的项目。但我想从内部了解script来自headerdocautomatically generate的注释。根据我所知道的运行 headerdoc 并将其收集到一个主文档的信息。有人帮我编写脚本以自动运行 headerdoc。提前致谢html outputXcodeTerminal