Xcode文档注释语法

Question

我想知道是否有人可以解释Xcode中以下两种注释语法之间是否存在差异。

/**
 * comments
 */

/*!
 * comments
 */

似乎两者都允许Xcode将您的评论显示为文档，但我不确定两者之间是否存在差异。

Answer 1

它们在功能上是等同的。 /*!是HeaderDoc样式的开场白，/**是JavaDoc常用的doxygen样式开场白。 Xcode 5支持HeaderDoc和doxygen / JavaDoc格式。

Answer 2

两者都是功能相同的。

<强>差异：

/ **

1. Doxygen风格
2. 如果您使用headerdoc2html命令，基于/**的评论将不会出现在文档文件中，它会跳过这些评论（请参阅HeaderDoc not generating HTML Documentation）

/ *！

1. HeaderDoc样式
2. 如果使用headerdoc2html命令，{/ 1}}注释将以HTML格式显示在文档文件中，与/ **
不同