iOS 注释大全

1.单行注释

1.1 简单注释

常用于 ==> 说明代码块中某段或某句的含义
用法 ==> 单独一行或者在某行代码的尾部
command + / 键 快捷注释某段代码

//注释文字

1.2 pragma mark

常用于 ==> 添加在代码行中便于从Xcode顶部地址栏中查找

#pragma mark 注释文字

2.多行注释

添加此注释后就会在写此方法的智能提示中显示此方法说明

2.1 简单注释

常用于 ==> 说明某个属性或者说明某个类的详情,也可注释某段代码
用法 ==>> 可书写多行
command + option + / 键 快捷注释某段代码

/**
  注释文字
  */

2.2 方法注释

常用于 ==> 说明某个方法
用法 ==>> 可分行书写多个参数信息
command + option + / 键 Xcode可智能列出注释参数

/**
此处可添加方法注释文字
@param first  注释此参数first
@param second 注释此参数second
@return 注释此方法返回参数
*/
- (NSString *)getResultWithParamFirst:(NSString *)first withParamSecond:(NSString *)second{

}

###附录:注释标记大全
添加下面参数 在Xcode中 option键+点击函数会调出详细注释,方便阅读代码

/** 
* @brief 简要描述 
* @author 标明开发该类模块的作者 
* @discussion 用途，方法
* @abstract   简介，概念
* @header  文件名
* @version 标明该类模块的版本 
* @see 参考转向,相关主题 
* @param 相关参数的说明 
* @return 对方法返回值的说明 
* @exception 对方法可能跑出的异常进行说明 
* @throw 抛出的异常 
* @since 从哪个版本此方法可以使用 
* @deprecated 弃用此API,从哪个版本开始 
* @serial (or @serialField or @serialData) 
* @link 链接相关方法 
* @copyright  版权
* /
参考网上帖子整理