xcode headerDoc 注释及自动生成文档。
http://kevin-wu.net/how-to-create-documentation-with-xcode/
规范注释生成器VVDocumenter + OSX 10.9.2
http://blog.csdn.net/jymn_chen/article/details/21452195
http://www.cnblogs.com/ygm900/p/3611232.html
通过右下角 show code snippet 创建自定义注释，可编辑快捷键。
将注释选中拖动到 show code snippet 然后编辑即可 创建一个新的快捷键。
http://www.th7.cn/program/ios/201408/263758.shtml
写函数时，提示的占位符 用这个语法即可 <#text description#> text description为提示占位符
headerDoc 注释示例
/*!
@header HellocDoc.h
@abstract aboutDiscription
@author Kevin Wu (作者信息)
@version 1.00 2012/01/20 Creation (此文档的版本信息)
*/
#import <Foundation/Foundation.h>
/*!
@enum
@abstract 关于这个enum的一些基本信息
@constant HelloDocEnumDocDemoTagNumberPopupView PopupView的Tag
@constant HelloDocEnumDocDemoTagNumberOKButton OK按钮的Tag
*/
typedef enum HelloDocEnumDocDemo_{
HelloDocEnumDocDemoTagNumberPopupView = 100,
HelloDocEnumDocDemoTagNumberOKButton,
}HelloDocEnumDocDemo;
/*!
@protocol
@abstract 这个HelloDoc类的一个protocol
@discussion 具体描述信息可以写在这里
*/
@protocol HelloDocDelegate <NSObject>
@end
/*!
@class
@abstract 这里可以写关于这个类的一些描述。
*/
@interface HelloDoc : NSObject {
}
/*!
* @property
* @abstract 这里可以写关于这个Property的一些基本描述。
*/
@property (nonatomic,readonly) NSString *helloDocText_;
/*!
* @brief 这里可以写一些关于这个方法的一些简要描述
* @discussion 这里可以具体写写这个方法如何使用，注意点之类的。如果你是设计一个抽象类或者一个
* 共通类给给其他类继承的话，建议在这里具体描述一下怎样使用这个方法。
* @param text 文字 (这里把这个方法需要的参数列出来)
* @param error 错误参照
* @result 返回结果
*/
- (BOOL)showText:(NSString *)text
error:(NSError **)error;
@end
/*!
@category
@abstract NSString的Category
*/
@interface KevinNSString (NSString)
@end