Xcode:用'///'或'//!'评论的区别关于文件

时间:2015-12-11 13:38:23

标签: xcode documentation comments

Xcode 中,如果您添加一行注释,以/////!/**/*!开头,用于多行注释)在方法声明中,它在快速帮助中显示(例如,方法名称上的Option Click)。

这些之间有什么区别吗?有人可以指出Apple开发者网站上记录的内容吗?

1 个答案:

答案 0 :(得分:1)

Xcode HeaderDoc支持记录在Mac Developer Library - HeaderDoc Tags

该文档自2013年以来尚未更新,但它确实显示了支持的评论语法:/*!和支持的@标记等。三个斜杠///只是另一种方式进行内联块文档。

HeaderDoc标签页面上未记录

/////!。这些可能是在Xcode 5中添加的。changelog状态:

  

框架API参考文档中的项目文档和您自己的源代码中的结构化注释显示在快速帮助面板和代码完成弹出视图中。 Doxygen和HeaderDoc结构化注释是受支持的格式。