Google Objective-C 的注釋

注釋

雖然寫起來很痛苦，但注釋是保證代碼可讀性的關(guān)鍵。下面的規(guī)則給出了你應(yīng)該什么時候、在哪進(jìn)行注釋。記?。罕M管注釋很重要，但最好的代碼應(yīng)該自成文檔。與其給類型及變量起一個晦澀難懂的名字，再為它寫注釋，不如直接起一個有意義的名字。

當(dāng)你寫注釋的時候，記得你是在給你的聽眾寫，即下一個需要閱讀你所寫代碼的貢獻(xiàn)者。大方一點，下一個讀代碼的人可能就是你！

記住所有 C++ 風(fēng)格指南里的規(guī)則在這里也同樣適用，不同的之處后續(xù)會逐步指出。

文件注釋

Tip
每個文件的開頭以文件內(nèi)容的簡要描述起始，緊接著是作者，最后是版權(quán)聲明和/或許可證樣板。

版權(quán)信息及作者

每個文件應(yīng)該按順序包括如下項：

• 文件內(nèi)容的簡要描述
• 代碼作者
• 版權(quán)信息聲明（如：Copyright 2008 Google Inc.）
• 必要的話，加上許可證樣板。為項目選擇一個合適的授權(quán)樣板（例如，Apache 2.0, BSD, LGPL, GPL）。

如果你對其他人的原始代碼作出重大的修改，請把你自己的名字添加到作者里面。當(dāng)另外一個代碼貢獻(xiàn)者對文件有問題時，他需要知道怎么聯(lián)系你，這十分有用。

聲明部分的注釋

Tip
每個接口、類別以及協(xié)議應(yīng)輔以注釋，以描述它的目的及與整個項目的關(guān)系。

    // A delegate for NSApplication to handle notifications about app
    // launch and shutdown. Owned by the main app controller.
    @interface MyAppDelegate : NSObject {
      ...
    }
    @end

如果你已經(jīng)在文件頭部詳細(xì)描述了接口，可以直接說明 “完整的描述請參見文件頭部”，但是一定要有這部分注釋。

另外，公共接口的每個方法，都應(yīng)該有注釋來解釋它的作用、參數(shù)、返回值以及其它影響。

為類的線程安全性作注釋，如果有的話。如果類的實例可以被多個線程訪問，記得注釋多線程條件下的使用規(guī)則。

實現(xiàn)部分的注釋

Tip
使用 | 來引用注釋中的變量名及符號名而不是使用引號。

這會避免二義性，尤其是當(dāng)符號是一個常用詞匯，這使用語句讀起來很糟糕。例如，對于符號 count ：

    // Sometimes we need |count| to be less than zero.

或者當(dāng)引用已經(jīng)包含引號的符號：

    // Remember to call |StringWithoutSpaces("foo bar baz")|

對象所有權(quán)

Tip
當(dāng)與 Objective-C 最常規(guī)的作法不同時，盡量使指針的所有權(quán)模型盡量明確。

繼承自 NSObject 的對象的實例變量指針，通常被假定是強(qiáng)引用關(guān)系（retained），某些情況下也可以注釋為弱引用（weak）或使用 __weak 生命周期限定符。同樣，聲明的屬性如果沒有被類 retained，必須指定是弱引用或賦予 @property 屬性。然而，Mac 軟件中標(biāo)記上 IBOutlets 的實例變量，被認(rèn)為是不會被類 retained 的。

當(dāng)實例變量指向 CoreFoundation、C++ 或者其它非 Objective-C 對象時，不論指針是否會被 retained，都需要使用 __strong 和 __weak 類型修飾符明確指明。CoreFoundation 和其它非 Objective-C 對象指針需要顯式的內(nèi)存管理，即便使用了自動引用計數(shù)或垃圾回收機(jī)制。當(dāng)不允許使用 __weak 類型修飾符（比如，使用 clang 編譯時的 C++ 成員變量），應(yīng)使用注釋替代說明。

注意：Objective-C 對象中的 C++ 對象的自動封裝，缺省是不允許的，參見 這里 <http://chanson.livejournal.com/154253.html>_ 的說明。

強(qiáng)引用及弱引用聲明的例子：

    @interface MyDelegate : NSObject {
     @private
      IBOutlet NSButton -okButton_;  // normal NSControl; implicitly weak on Mac only

      AnObjcObject- doohickey_;  // my doohickey
      __weak MyObjcParent -parent_;  // so we can send msgs back (owns me)

      // non-NSObject pointers...
      __strong CWackyCPPClass -wacky_;  // some cross-platform object
      __strong CFDictionaryRef -dict_;
    }
    @property(strong, nonatomic) NSString -doohickey;
    @property(weak, nonatomic) NSString -parent;
    @end

（譯注：強(qiáng)引用 - 對象被類 retained。弱引用 - 對象沒有被類 retained，如委托）