问题标签 [headerdoc]

我已经定义了一个协议并将 HeaderDoc 文档添加到该协议中的方法中。当我 Option+单击该方法时，它会正确显示：

但是，当我 Option+单击实现此协议的控制器中的实现时，文档未显示：

我的期望是我为协议编写的文档会出现在控制器中，类似于 Apple 的文档：

如何让我的协议文档在其他地方可见？

I have seen that Apple's HeaderDoc User Guide has been marked as "Retired Document" with this note:

Important: This document may not represent best practices for current development. Links to downloads and other resources may no longer be valid.

This document was last updated in May. So... which the best practices for documenting code now in Xcode 8 would be? I don't find further information regarding this.

我在 Swift 中有以下文档注释：

说“警告”的行不会在 Xcode 中呈现，因为“-警告”是 swift 文档注释中的关键字标注。我怎样才能逃避标注？

Objective-C 文档 (HeaderDoc) 中有没有办法隐藏某些评论不让公众看到？

换句话说，当您在您正在调用的方法上单击（alt-单击）时，会弹出该框，显示该方法的注释...我希望对该方法的某个注释不显示在该框中.

这是我的场景：

现在，当有人doSomthing()在 Swift 中使用并查看文档弹出框时，关于的评论对NS_SWIFT_NAME他们来说毫无意义（它没有关于该方法如何工作或如何使用它的有用 API 信息）。所以，我不希望该评论出现。

但是，如果有人要查看实际方法并NS_SWIFT_NAME在那里查看，我希望他们能够知道它为什么存在。而且我不想将注释拉到文档块之外并使其成为//代码注释，因为我认为那会很丑陋。

是否有任何关键字可以让您在标题文档中隐藏某些评论？喜欢@hide还是什么？

我们目前正计划使用评论创建文档。因此，任何人都知道如何实现这一目标。正如我已经检查了大多数 Doxygen/headerdoc 不支持 Swift 的帖子。