2011-10-10 91 views
3

我刚刚发现了一些Xcode中示例项目此评论声明:/*! */ 那是什么意思?

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

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

+1

相关到http: //stackoverflow.com/questions/6605535/what-are-documentation-comments-in-xcode? – Cyrille

+0

是的,你说得对,谢谢! – Faser

回答

4

为了从headerdoc简单一点,appledoc过渡(收费站从代码中生成文档,以便您保存文档的时间)也接受headerdoc风格多行注释:

/*! Comment */ 

Source

+0

所以基本上,如果我有appledoc,那将使用该注释来编写文档?好:) – Faser

2

在Objective-C中,注释仅由/ * * /分隔,所以您是对的,感叹号不需要形成注释。但是,在这种情况下,!有一种说法是应该通过自动文档工具(如Doxygen或AutoDoc)来读取该提交。这里的@符号也是一样。 @property说你正在记录一个名为masterVolume的属性,@abstract描述了属性的用途。

2

这是一个Qt评论风格。它被Doxygen,HeaderdocAppledoc作为块注释处理。作者熟悉Qt编程并选择了评论风格。他本可以选择/**,只是一个品味问题。