【问题标题】:/*! */ What does that mean?/*! */ 那是什么意思?
【发布时间】:2011-12-04 15:17:52
【问题描述】:

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

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

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

【问题讨论】:

标签: objective-c xcode syntax comments


【解决方案1】:

为了更简单地从 headerdoc 转换,appledoc(从代码生成文档的工具,以便您节省文档时间)也接受 headerdoc 样式的多行 cmets:

/*! Comment */

Source

【讨论】:

  • 所以基本上,如果我有appledoc,那将使用该注释来编写文档?不错:)
【解决方案2】:

这是一种 Qt 评论风格。 doxygenHeaderdocAppledoc 将其视为块注释。作者熟悉 Qt 编程,选择了那种注释风格。他本可以选择/**,只是口味问题。

【讨论】:

    【解决方案3】:

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

    【讨论】:

      猜你喜欢
      • 2017-11-03
      • 1970-01-01
      • 1970-01-01
      • 2019-07-21
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2018-03-09
      • 1970-01-01
      相关资源
      最近更新 更多