ios中评论中惊叹号的重要性

时间:2014-01-24 07:38:55

标签: ios objective-c coding-style comments

我见过程序员使用以下格式的评论:

/*! This is a sample comment
*/

我在ios开发时第一次看到了这样的评论,即在objective-c中。 这里有'!'(感叹号)有什么意义?

1 个答案:

答案 0 :(得分:5)

这是HeaderDoc

的引用标记

您通常会在与方法,函数或变量“链接”的注释中看到它。

例如:

/*!
 This is a comment about FunctionName.
*/
char *FunctionName(int k);

如果您在Xcode 5.1中使用这些注释,您可以使用这些文档popovers(选项+单击方法)来获取您自己的代码:

enter image description here

所以期待将来更频繁地看到这些事情。 : - )

如果您想自己使用它们,我建议您查看VVDocumenter,这是一个Xcode插件,可以让您更轻松地创建它们。