/ *! */ 那是什么意思?

时间:2011-10-10 15:33:08

标签: objective-c xcode syntax comments

我刚在一些xcode示例项目中找到了这个注释声明:

/*!
@property masterVolume
@abstract Sets the master volume
*/
@property float masterVolume;

评论像往常一样是绿色,@ property和@摘要是深绿色。如果我删除感叹号,它们会有相同的绿色。这到底是什么意思?

3 个答案:

答案 0 :(得分:4)

要从headerdoc转换更简单一点,appledoc(从代码生成文档以便节省文档时间)也接受headerdoc样式的多行注释:

/*! Comment */

Source

答案 1 :(得分:2)

在Objective-C中,注释仅由/ * * /分隔,因此您是对的,感叹号不是形成注释所必需的。但是,在这种情况下,!可以说,该提交应该由自动文档工具读取,例如Doxygen或AutoDoc。那里的@符号也是如此。 @property表示你正在记录一个名为masterVolume的属性,而@abstract正在描述该属性的用途。

答案 2 :(得分:2)

这是一种Qt评论风格。它被doxygenHeaderdocAppledoc视为块注释。作者熟悉Qt编程并选择了评论风格。他本可以选择/**而不是品味。