說(shuō)明
AppleDoc支持多種注釋方式，這里只介紹一種自認(rèn)為最簡(jiǎn)單合適的方法昏鹃，通過(guò)其他關(guān)鍵字如@discussion @brief也能達(dá)到類(lèi)似的效果尚氛，這里不做一一介紹。
Example
#import <Foundation/Foundation.h>
/**這里是枚舉的簡(jiǎn)介
這里是枚舉的詳述洞渤，枚舉的開(kāi)頭注釋要采用多行注釋?zhuān)嘈凶⑨尡仨氁孕备芗觾蓚€(gè)星號(hào)開(kāi)頭阅嘶，以一個(gè)星號(hào)加斜杠結(jié)尾，中間每一行不需要加星號(hào)载迄。詳述與上面簡(jiǎn)介需要有一個(gè)空行奈懒。
詳述可以省略
@warning 可以省略，如果有一些需要提醒用戶的地方可以用`warning`提醒宪巨，另外磷杏，如果有內(nèi)容變更也可以通過(guò)這種方式體現(xiàn)
@warning `warning`可以寫(xiě)多個(gè)，生成html中會(huì)分多個(gè)`warning`進(jìn)行顯示
@since v5.4.0
*/
typedef NS_ENUM(NSInteger, TestEnum) {
/**
這里是這個(gè)枚舉的簡(jiǎn)介
這里是這個(gè)枚舉的詳述捏卓，可以省略极祸，如果有，則需要與簡(jiǎn)介隔一行
@since v5.4.0
*/
TestEnum1 = 0,
/**
這里是這個(gè)枚舉的簡(jiǎn)介
這里是這個(gè)枚舉的詳述怠晴，可以省略遥金，如果有，則需要與簡(jiǎn)介隔一行
@since v5.4.0
@deprecated v5.5.0
*/
TestEnum2 = 1 DEPRECATED_ATTRIBUTE,
};
/**
類(lèi)的開(kāi)頭注釋與枚舉的開(kāi)頭注釋相同
類(lèi)的開(kāi)頭注釋中還可以對(duì)類(lèi)中的方法和屬性進(jìn)行引用達(dá)到鏈接的效果`propertyNew`
類(lèi)的開(kāi)頭注釋中可以增加代碼實(shí)例(注意下面代碼前后要有空行蒜田，且需要縮進(jìn))：
TestAppleDoc *appleDoc;
appleDoc.propertyNew = @"appledoc";
但是不能出現(xiàn)類(lèi)中不存在的方法稿械，如`alloc, init`，雖然是系統(tǒng)方法冲粤，但`appledoc`并不認(rèn)美莫，會(huì)報(bào)錯(cuò)
@since v5.4.0
*/
@interface TestAppleDoc : NSObject
///---------------------------------------------------------------------------------------
/// @name properties
///---------------------------------------------------------------------------------------
/**
屬性的注釋
關(guān)于屬性的描述页眯，替代`propertyDeprecated`
@since v5.5.0(表示從5.5.0版本新增)
*/
@property (nonatomic, copy) NSString* propertyNew;
/**
如果接口或?qū)傩员粡U棄，則在簡(jiǎn)介或詳述中說(shuō)明這是一個(gè)被廢棄的屬性厢呵，請(qǐng)使用`propertyNew`
@since v5.3.0(表示從5.3.0版本新增)
@deprecated v5.5.0(表示從5.5.0版本廢棄)
*/
@property (nonatomic, copy ,readonly) NSString* propertyDeprecated DEPRECATED_ATTRIBUTE;
/**
這是一個(gè)枚舉屬性窝撵，下面`@see`可以鏈接到`TestEnum`的定義
@see TestEnum
@since v5.4.0
*/
@property (nonatomic, assign) TestEnum te;
///---------------------------------------------------------------------------------------
/// @name methods
///---------------------------------------------------------------------------------------
/**這里是方法簡(jiǎn)介
這里是方法詳述，與上面簡(jiǎn)介需要隔一行襟铭，在這里可以描述方法的詳細(xì)用法
@param te `TestEnum`類(lèi)型參數(shù)
@return 返回`uSDKDeviceInfo`實(shí)例
@warning v5.4.1版本中接口發(fā)生變化碌奉，需要先xx，再調(diào)用該方法才能生效(即可以通過(guò)該方式聲明接口變更)
*/
- (instancetype)initWithTestEnum:(TestEnum)te;
@end
