iOS文檔註釋

Eclipse和IntelliJ IDEA系的IDE都有自動生成文檔註釋的功能，Xcode雖然安裝了VVDocument，但是仍然感覺註釋的功能不是很完善，於是今天整理了一下書寫文檔註釋的一些用法。
首先要說的就是文檔註釋提取的工具：主要是介紹HeaderDoc和appleDoc
1.我們平常長按option鍵同時滑鼠點擊，彈出的文檔就是Xcode會自動使用HeaderDoc生成的。如圖：

2.appleDoc只為Objective-C服務，可以在文檔書寫完成之後使用appledoc生成docSet，能生成和Apple一個風格的文檔，如下所示：

然後要說的就是一些編寫文檔註釋的規範了：(註意本文值討論文檔註釋，僅僅作為解釋說明的註釋不會涉及)

單行註釋

共有以下幾種：
行前註釋：(經常用作對屬性的聲明)

///

行後註釋：(一般對屬性、成員變數的聲明、代碼說明等)

/**< 
/*!<
///< 
//!< 

使用的方法如下：

/// 姓名
@property (nonatomic, copy) NSString *name;

@property (nonatomic, copy) NSString *phone; /**< 電話 */
@property (nonatomic, copy) NSString *address; /*!< 住址 */
@property (nonatomic, assign) float height; ///< 身高
@property (nonatomic, assign) NSUInteger age; //!< 年齡

多行註釋

常用以下幾種：(經常用在類聲明和方法聲明之前)

/// line1
/// line2

/**
 * line1
 * line2
 */

/*! line1
 *  line2
 */

示例如下：

/*!
 * Comment
 */
@interface Comment : NSObject

/**
 *  an exmaple
 *
 *  @param obj input parameter
 */
- (void)commonMethod:(id)obj;

/// exmaple 2
/// @param obj input parameter
- (void)commonMethod2:(id)obj;

@end

註釋Tag

在寫方法的文檔註釋的時候多用一些參數說明, 這時候會用到@param標簽，除此之外還有其他標簽

下麵是在所有的方法聲明前使用的標簽：

還有一些可以在類型定義，方法聲明和頭文件中都可以使用的tag

另外有一些關於整個文件的一些文檔註釋tag：