Objective-C 文档 (HeaderDoc) 中有没有办法隐藏某些评论不让公众看到?
换句话说,当您在您正在调用的方法上单击(alt-单击)时,会弹出该框,显示该方法的注释...我希望对该方法的某个注释不显示在该框中.
这是我的场景:
/**
* This method does something.
*
* For more info on why NS_SWIFT_NAME is specified on this, see: <link here>
*/
- (void)doSomething NS_SWIFT_NAME(doSomething())
现在,当有人doSomthing()
在 Swift 中使用并查看文档弹出框时,关于的评论对NS_SWIFT_NAME
他们来说毫无意义(它没有关于该方法如何工作或如何使用它的有用 API 信息)。所以,我不希望该评论出现。
但是,如果有人要查看实际方法并NS_SWIFT_NAME
在那里查看,我希望他们能够知道它为什么存在。而且我不想将注释拉到文档块之外并使其成为//
代码注释,因为我认为那会很丑陋。
是否有任何关键字可以让您在标题文档中隐藏某些评论?喜欢@hide
还是什么?