【iOS】Object-C注釋

與其他語言一樣，Object-C的注釋也分為兩種，一種是普通注釋，一種是文檔注釋，普通注釋通常給閱讀代碼的人看，而文檔注釋可以被appledoc識別，在使用的時候xcode能給出智能提示

 

簡單注釋
　　1、單行注釋

　　　　單行注釋不能被文檔識別，通常用於函數內部

//學生信息

　　2、多行注釋（這個也可以被識別）

/*
 *　多行注釋內容
 */

 

文檔注釋（appledoc可識別成文檔）

　　1、單行注釋

@interface Student : NSObject ///名字
@property (nonatomic, copy) NSString *name; ///年齡
@property (nonatomic, assign) NSInteger age; ///校園卡Id
@property (nonatomic, copy) NSString *schoolId; ///年紀
@property (nonatomic, copy) NSString *grade; @end

　　　　如果安裝了 VVDocument ，當輸入///的時候回自動生成多行注釋，通常我們通過 /** 注釋內容 */ 進行注釋

@interface Student : NSObject /** 名字 */ @property (nonatomic, copy) NSString *name; /** 年齡 */ @property (nonatomic, assign) NSInteger age; /** 校園卡Id */ @property (nonatomic, copy) NSString *schoolId; /** 年紀 */ @property (nonatomic, copy) NSString *grade; @end

　　2、多行注釋

/** 簡要描述. * * 詳細描述或其他. */

　　3、行尾注釋

　　　　如上面的單行注釋，當屬性多了之后看起來會比較混亂，我們也可以用下面的行尾注釋，也可以被xcode識別

@interface Student : NSObject @property (nonatomic, copy) NSString *name;         /**< 名字 */ @property (nonatomic, assign) NSInteger age; /**< 年齡 */ @property (nonatomic, copy) NSString *schoolId;     /**< 校園卡Id */ @property (nonatomic, copy) NSString *grade;        /**< 年紀 */

@end 

 　　4、函數注釋

　　　　函數注釋也屬於多行注釋，通常我們使用 VVDocument 插件輔助

/** * 獲取狀態描述 * * @param state 狀態值 * * @return 返回狀態描述 */
- (NSString *)getState:(NSInteger)state { switch (state) { case 1: return @"待確認"; break; case 2: return @"確認"; break; case 3: return @"駁回"; break; } }

 

　　在實際開發中，我們應該多使用文檔注釋，使用文檔注釋可以獲得xcode的智能提示，在用appledoc生成文檔的時候也可以被識別

參考鏈接：http://www.cnblogs.com/zyl910/archive/2013/06/07/objcdoc.html