歡迎到我的 個人博客 http://liumh.com 瀏覽此文
本文記錄的是如何更好的編寫注釋。好的注釋，可以讓使用者能夠像使用官方文檔一樣，使用 option + 單擊 就可查看其使用說明。
對于枚舉類型，可以像如下這樣:
/** 定義的HTTP請求類型 */
typedef NS_ENUM(NSUInteger, ACLApiManagerRequestType) {
ACLApiManagerRequestTypeGet, /**< Get請求 */
ACLApiManagerRequestTypePost, /**< Post請求 */
};
請自行注意注釋使用的符號, 注釋枚舉值和枚舉類型時使用的符號也有差別。
對于屬性，可以像如下這樣:
@property (nonatomic, copy, readonly) NSString *errorMessage; /**< 錯誤信息說明 */
對于方法的注釋，強烈建議安裝喵神的插件VVDocumenter-Xcode。然后在方法上部連續鍵入///觸發插入注釋，然后刪除 placeholder 的地方，填入實際的注釋說明，如下:
/**
* <#Description#>
*
* @param manager <#manager description#>
* @param data <#data description#>
*
* @return <#return value description#>
*/
- (BOOL)manager:(ACLAPIBaseManager *)manager isCorrectWithParamsData:(NSDictionary *)data;
但是對于沒有參數的方法，或者我們覺得方法的命名自解釋已經很清楚了，則可以像如下注釋:
/** API 請求除 base url 之外的 url部分 */
- (NSString *)methodName;
參考:
