2011-10-10 93 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編程並選擇了評論風格。他本可以選擇/**,只是一個品味問題。