代码注释大家应该都了解,代码注释的作用也不言而喻。
注:文中的参数名和方法名仅用作对注释的说明,请勿对命名的规范性深究。
那么,iOS中的代码注释都有那些呢?
通用的注释:
//这是一条注释
/*这也是一条注释*/
参数的注释:
@property (nonatomic, copy) NSString *userName;//用户名
@property (nonatomic, copy) NSString *userName;/**< 用户名 */
/*! * @brief 用户名 */ @property (nonatomic, copy) NSString *userName;
后面两种方便我们在使用参数的时候可以方便的看到注释,更直接更明白。
方法的注释:
//登录 - (void)login { //do }
/*! * @brief 登录 */ - (void)login { //这种注释方便我们在调用该方法的时候可以看到注释。 }
/** 登录 */ - (void)login { //这种注释方便我们在调用该方法的时候可以看到注释。 }
方法区分:
#pragma mark 方法区分
#pragma mark – 方法区分
区别:- 横线会多一条分割线。
辅助注释:
在编译的时候会产生错误信息或警告信息。
#error 这里是错误信息
#warning 这里是警告信息
特殊注释:
//TODO:待处理
//FIXME:待修复
//!!!:重要信息
//???:这是问题
如果需要在编译的时候对这些注释产生警告,那么就需要我们多一步处理。
展开刚出现那一栏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/"
这样编译的时候就会产生我们想要的效果。
类注释:
类注释在创建的时候Xcode已经帮我们设置好了大部分。
当然对于版本,类的作用等描述性信息,如有需要自己可以另行添加。
// // ViewController.m // ProjectName // Version 1.0 // Created by awnlab on 15/7/14. // Copyright (c) 2015年 awnlab.com. All rights reserved. //
代码注释工具:
XToDo 下载编译后重启,在View -> Snippets中可以快速插入TODO、FIXME、!!!、??? 注释,同时还有快捷键使用。
结束语:
注释虽好,可不要滥用哦。