代码注释

1、#pragma mark

#pragma mark -
#pragma mark Table Delegate Methods

从技术上讲，以 #pragma 开头的代码是一条编译器指令，是一个特定于程序或编译器的指令。它们不一定适用于其它编译器或其它环境。如果编译器不能识别该指令，则会将其忽略。

作用： 

告诉Xcode编译器，要在编辑器窗格顶部的方法和函数弹出菜单中将代码分隔开，如下图所示：

 

 

2、属性注释

@property(nonatomic, copy)NSString* trackerId;/**< 即appid 标识 */

即在别处该属性值上按下option键，单击即可查看注释

 

 

3、方法注释

/** 自定义事件,时长统计.

    使用前，请先到友盟App管理后台的设置->编辑自定义事件 中添加相应的事件ID，然后在工程中传入相应的事件ID.

    beginEvent,endEvent要配对使用,也可以自己计时后通过durations参数传递进来

 @param  eventId 网站上注册的事件Id.

 @param  label 分类标签。不同的标签会分别进行统计，方便同一事件的不同标签的对比,为nil或空字符串时后台会生成和eventId同名的标签.

 @param  primarykey 这个参数用于和event_id一起标示一个唯一事件，并不会被统计；对于同一个事件在beginEvent和endEvent 中要传递相同的eventId 和 primarykey

 @param millisecond 自己计时需要的话需要传毫秒进来

 @return void. 

 @warning 每个event的attributes不能超过10个

    eventId、attributes中key和value都不能使用空格和特殊字符，且长度不能超过255个字符（否则将截取前255个字符）

    id， ts， du是保留字段，不能作为eventId及key的名称

@noto 注意！！！！！

*/

+ (void)beginEvent:(NSString *)eventId;

同样按下option键，单击即可查看注释

 

 

4、特殊注释:

// TODO:
// FIXME:
// !!!:
// ???:

在Targets的Build Phases点击 左上角＋选择Run Script，输入

KEYWORDS="TODO:|FIXME:|\?\?\?:|\!\!\!:"

find "${SRCROOT}" \( −name "*.h" −or −name "*.m" \) -print0 | xargs

-0 egrep --with-filename --line-number --only-matching

"($KEYWORDS).*\$" | perl -p -e "s/($KEYWORDS)/ warning: \$1/"

此时即可在Warning列表中看到注释（会有错误警告，还未找到方法）

 

还会这样

5、类简介

/*! @brief 微信通知第三方程序，要求第三方程序显示或处理某些消息，第三方程序处理完后向微信终端发送的处理结果。

 *

 * 微信需要通知第三方程序显示或处理某些内容时，会向第三方程序发送ShowMessageFromWXReq消息结构体。

 * 第三方程序处理完内容后调用sendResp向微信终端发送ShowMessageFromWXResp。

 */

@interface ShowMessageFromWXResp : BaseRes