文件头部的注释
/*! @header HttpMsgCtrl @abstract 网络连接池 @author AAA初期, BBB修改 @version v1.0.005 15-9-6 @discussion 1、 15-8-24 发送请求前在cookie里面添加cityId字段。 2、 15-8-28 请求到头时判断登录session是否失效,失效就标记为未登录, 并发送全局通知 3、 15-9-4 调整超时时间 需要除去1.5 4、 15-9-6 添加了get方法请求, 添加了重写cookie的操作 */
这种注释写在文件头顶部,作用就是在维护开发的时候难免人员交替开发同一文件,每人每次对这个文件更改都需要在注释这里登记,如果在测试的时候这个模块的某个功能出问题了,可以根据这个注释很快的找到哪个人在什么时候改了某块代码,从而可以从github上快速的找到更改过的代码块,使分工明确化,功能具体化
方法注释
/**! @method - (BOOL)isDataAvailable; @abstract 判断数据是否可用 @return YES:不可用,有数据为空; NO:数据可用 */ -(BOOL)isDataAvailable;这种注释方法很清楚的提供了,方法的作用,以及返回参数的作用,方便阅读
/**! @method -(void)updateLocationButtonFrame; @abstract 刷新布局 @return void */ -(void)updateLocationButtonFrame;在没有返回参数的方法时,使用这种注释方法
<span style="font-family: Arial, Helvetica, sans-serif;">/**</span>
@brief 用户登录填写的Email,密码,平台,代理 @param email [email protected] @param pwd 用户密码 @param ptf 平台名称 @param delegate 响应代理者 */ -(void)loginUserWithEmail:(NSString*)email password:(NSString*)pws platform:(NSString*)ptf delegate:(id)delegate;
/*! @function -(id)initWithFrame:(CGRect)frame buttonTitles:(NSArray *)titles @abstract 初始化一个已知尺寸与标题的选项卡,每个选项的大小(frame.size.width/[titles count]) @param (CGRect)frame: 选项卡的frame @param (NSArray *)titles: 数组里面包含的每个对象为选项卡标题 @return 生成一个选项卡对象 */ -(id)initWithFrame:(CGRect)frame buttonTitles:(NSArray *)titles;这种为有返回数据的,重点在于return的数值的具体作用的相关交代
/**
这是一个我的model
*/
@property(nonatomic,strong)NSObject * myObject;
这种注释,可以在点击 option+左击 对象时,将 注释内容显示在description中,在调用的时候也可以清除的看到注释内容