如何隐藏某些Objective-C方法头文档(HeaderDoc)注释

时间:2016-10-21 14:10:56

标签: objective-c code-documentation headerdoc

Objective-C文档(HeaderDoc)中是否有一种方法可以隐藏某些注释,使其不被公众看到?

换句话说,当您对正在调用的方法进行选项单击(alt-click)时,会弹出该框,显示该方法的注释...我希望对该方法的某些注释不出现在那个盒子里。

这是我的情景:

/**
 * 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())

现在,当有人在Swift中使用doSomthing()并查看文档弹出框时,关于NS_SWIFT_NAME的评论对他们没有意义(它没有关于方法如何工作的有用API信息或者如何使用它)。所以,我不想让评论显示出来。

但是,如果有人要查看实际方法并在那里看到NS_SWIFT_NAME,我希望他们能够知道它为什么存在。而且我不想在文档块之外提取注释并将其作为//代码注释,因为我认为这会非常难看。

是否有任何关键字可以隐藏标题文档中的某些评论?像@hide或其他什么?

0 个答案:

没有答案