Objective C @property comments

Question

我使用Doxygen爲我的客觀c代碼生成文檔。到目前爲止，我還沒有找到任何關於如何正確記錄屬性的指導。我看過的例子都是可以想到的。有些人自己記錄變量，有些人記錄@property聲明。有些使用//，而其他使用全/ ** * /塊。

任何人都可以指出我的最佳實踐參考？或者也許有關於Doxygen未來兼容性的一些信息？我想堅持一種模式，一旦他們發展出正式模式，至少可以很容易地適應Doxygen。

Answer 1

我能說的是，Core Plot framework使用的格式一樣

/** @property myProperty 
* @brief Property is very useful 
* Useful and there is a lot more to tell about this property **/ 

註釋屬性聲明的實施，似乎生產使用Doxygen的乾淨文件。從Core Plot documentation policy：

的@財產被要求作爲doxygen的 找不到屬性名 否則。

像只讀存取器屬性， 複製/保留/分配和非原子被自動添加 並在 文檔的手動部分不應 發生。

Answer 2

在這裏您可以找到有關編碼約定的Objective-C的一些信息：Google Objective-C Style Guide

但是如果你想，有一個其他良好的軟稱爲HeaderDoc下生成的XCode文檔。你可以在這裏查看它的編碼風格：HeaderDoc Tags

Answer 3

我的經驗是：

當我使用註釋裏面的@property標籤，屬性doxygen的輸出被損壞，如：[類名]：讀，寫，分配。

如果我ommit @property標籤，而是依靠doxygen在源代碼中找到'@property'聲明，正好在註釋塊下面，一切正常。

相比之下，@interface適用於接口，而@protocol適用於協議。

另外，在過去，我在某些協議聲明上做了doxygen'slip'。 Obj-C仍然是二等公民？

注：我使用的GUI /嚮導在Mac上，並註釋塊使用 '！/ * *'而不是'/ * *'。