iOS文档生成

appledoc --project-name "sinablogHD" --project-company "sina" --company-id cn.com.sina --ignore ".m" --explicit-crossref --keep-undocumented-objects --keep-undocumented-members --no-repeat-first-par --no-warn-missing-arg --no-warn-undocumented-object --no-warn-undocumented-member --no-warn-empty-description --docset-bundle-id "sinablogHDDoc" --docset-bundle-name "sinabloadHDDoc" --keep-intermediate-files --output ~/Desktop/sinablogHDDoc .

下面就详细介绍一下各种能自动生成文档的注释
■ header : 头文件基本信息。这个用在每个源代码文件的头文件的最开头。
例如:

/*!
@header 这里的信息应该与该源代码文件的名字一致
@abstract 关于这个源代码文件的一些基本描述
@author Kevin Wu (作者信息)
@version 1.00 2012/01/20 Creation (此文档的版本信息)
*/

■ class: 类信息。此注释用在类声明的开头。
例如:

/*!
@class
@abstract 这里可以写关于这个类的一些描述。
*/
@interface MyClass : NSObject {
}

■ property: property的相关注释。

/*!
@property
@abstract 这里可以写关于这个Property的一些基本描述。
*/
@property (nonatomic ,readonly ) NSString *helloDocText_ ;

■ method: 函数(方法)的相关注释。

/*!
@method
@abstract 这里可以写一些关于这个方法的一些简要描述
@discussion 这里可以具体写写这个方法如何使用，注意点之类的。如果你是设计一个抽象类或者一个
共通类给给其他类继承的话，建议在这里具体描述一下怎样使用这个方法。
@param text 文字 (这里把这个方法需要的参数列出来)
@param error 错误参照
@result 返回结果
*/
- (BOOL )showText : (NSString * )text
error : (NSError ** )error ;

■ enum: enum的相关注释。

/*!
@enum
@abstract 关于这个enum的一些基本信息
@constant HelloDocEnumDocDemoTagNumberPopupView PopupView的Tag
@constant HelloDocEnumDocDemoTagNumberOKButton OK按钮的Tag
*/
typedef enum HelloDocEnumDocDemo_ {
HelloDocEnumDocDemoTagNumberPopupView = 100 ,
HelloDocEnumDocDemoTagNumberOKButton ,
}HelloDocEnumDocDemo ;

■ category: category的相关注释。

/*!
@category
@abstract NSString的Category
*/
@interface KevinNSString (NSString )

■ protocol: protocol的相关注释

/*!
@protocol
@abstract 这个HelloDoc类的一个protocol
@discussion 具体描述信息可以写在这里
*/
@protocol HelloDocDelegate ＜NSObject＞

以上列举的标准注释也许并不完善。
具体请参考苹果的developer网站的API文档。
以上列举的标准注释全都在下面的头文件里，仅供参考。
HelloDoc.h