當它需要的時候,注釋應該用來解釋特定的代碼做了什么。所有的注釋必須被持續維護或者干脆就刪除。
塊注釋應該被避免,代碼本身應該盡可能就像文檔一樣表示意圖,只需要很少的打斷注釋 _例外: 這不能適用于用來產生文檔的注釋_
### 頭文檔
一個類的文檔應該只在 .h 文件里用 Doxygen/AppleDoc 的語法書寫。 方法和屬性都應該提供文檔。
**例子: **
~~~
/**
* Designated initializer.
*
* @param store The store for CRUD operations.
* @param searchService The search service used to query the store.
*
* @return A ZOCCRUDOperationsStore object.
*/
- (instancetype)initWithOperationsStore:(id<ZOCGenericStoreProtocol>)store
searchService:(id<ZOCGenericSearchServiceProtocol>)searchService;
~~~