【iOS】Object-C註釋

與其餘語言同樣，Object-C的註釋也分爲兩種，一種是普通註釋，一種是文檔註釋，普通註釋一般給閱讀代碼的人看，而文檔註釋能夠被appledoc識別，在使用的時候xcode能給出智能提示

 

簡單註釋
　　一、單行註釋

　　　　單行註釋不能被文檔識別，一般用於函數內部

//學生信息

　　二、多行註釋（這個也能夠被識別）

/*
 *　多行註釋內容
 */

 

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

　　一、單行註釋

@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

　　二、多行註釋

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

　　三、行尾註釋

　　　　如上面的單行註釋，當屬性多了以後看起來會比較混亂，咱們也能夠用下面的行尾註釋，也能夠被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 

 　　四、函數註釋

　　　　函數註釋也屬於多行註釋，一般咱們使用 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