问题标签 [headerdoc]

我想开始正确地记录我的代码，但我不确定将它放在哪里最好让 HeaderDoc 阅读。我在 HeaderDoc 文档中阅读了以下短语，这让我认为预期的位置（从 Apple 的角度来看）在头文件中？

如果您愿意，您可以指定一个输入目录，而不是指定单个输入文件（如上所述）。HeaderDoc 将处理输入目录（及其所有子目录）中的每个 .h 文件，为每个包含 HeaderDoc 注释的标题生成 HTML 文件的输出目录。

这是正确的吗？我放置文档的位置会有所不同吗？

我写了很多 C#，在 Visual Studio 中，当自动完成功能出现描述函数及其参数时，我可以看到我自己的文档。使用我的 HeaderDoc 描述在 Xcode 中是否可以使用相同的功能？

如果它有助于任何答案的相关性，我正在使用 Xcode 4。

我通常需要在代码注释中写很多短代码，比如this. 这可以在 Apple 的Headerdoc中使用吗？因为这种类型的代码符号通常被大量使用，所以我相信有一种方便的方法可以做到这一点，而不是标记 HTML 标记。

我在一些示例代码中看到了@discussion。我的问题是，使用这个关键字有什么好处？

我想它会生成更好的文档。我尝试在 Google 和 Stackoverflow 上搜索，但得到了很多代码示例，而不是如何使用这个关键字。谢谢。

我想记录我的界面。该接口是用 C++ 编写的，它位于 .hpp 文件中。但是，headerdoc2html似乎不知道 .hpp 文件；它需要 .h 文件。

如何强制 HeaderDoc 将输入解释为 C++ 代码？

我需要为我的工作场所实施文档生成解决方案，并将其范围缩小到标题中提到的三个。在这些解决方案之间进行形式化比较的方式中，我能够找到的信息非常少，我希望你们中具有上述一项或多项经验的人能够参与进来：

以下是我从最初的通行证中收集到的信息：

HeaderDoc 优点：与苹果现有的文档一致，与制作苹果文档集的兼容性
HeaderDoc 缺点：难以修改行为，项目没有积极开展，许多人已经放弃它（意味着一定有缺陷，虽然我无法量化它）。

Doxygen 优点：积极支持广泛使用基础的社区 b/c，非常可定制，大多数输出​​类型（如乳胶等）
Doxygen 缺点：需要努力使其外观/行为与苹果文档一致，与苹果文档集的兼容性并不那么简单

AppleDoc 优点：看起来与苹果现有的文档一致，与制作苹果文档集的兼容性，
AppleDoc 缺点：类型定义、枚举和函数的文档存在问题，正在积极开发中

这听起来准确吗？我们所需的解决方案将具有：

• 与苹果objective-c 类参考一致的外观
• 能够通过选项单击从 Xcode 中提取文档参考，然后链接到文档（就像苹果的类一样）
• 智能处理类别、扩展等（甚至是苹果类的自定义类别）
• 能够创建我们自己的参考页面（比如这个页面：加载中……可以包含图像，并且可以从生成的类引用无缝链接，比如苹果的 UIViewController 类引用如何链接到链接页面。
• 易于运行的命令行命令，可以集成到构建脚本中
• 优雅地处理非常大的代码库

基于以上所有信息，上述任何解决方案是否明显优于其他解决方案？任何要添加的建议或信息将不胜感激。

我正在尝试为我的一个项目生成苹果文档。我正在使用以下命令生成文档...

我收到以下消息...

任何帮助表示赞赏。

由于 XCode 5 现在支持直接从头文件中读取头注释，因此以一致的方式记录功能变得越来越有趣。

因此，我尝试找到一种可以在 Objective C 头文件中自动插入 header doc 注释的工具，但似乎找不到？

基本上我想要一个可以写如下内容的镜头：

UIApplication的文档包含一个Notification部分，其中列出了所有相关的NSNotification 。

不幸的是，Xcode 中可用的头文件不包含相应的注释。

HeaderDoc用户指南展示了如何使用@group标签将项目组合在一起，解释了类似于UIApplication文档的结果。

分组标签允许您将函数、方法和变量组织到集合中。在 HTML 输出模式中，目录（左列）被组织成这些组。此外，正文内容（右侧）包含每个组的文档。该文档块包含该组的名称、讨论以及该组中包含的任何函数、数据类型或变量的列表，以及它们的摘要。

但是，当我尝试使用该@group标签时，我收到一个警告Unknown command tag name，并且该@group标签没有以深绿色突出显示，使得 Xcode 似乎无法识别它。

这是我的代码

当我WOC_OnOffImageButton在弹出窗口中进行 alt-click 时，Description我将In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images全部放在一行中。

我想在 之间换行... click. Automatically...，因为这样更容易阅读。

问题
是否可行，如果可以，该怎么做？