iOS注释那些事儿

代码注释大家应该都了解,代码注释的作用也不言而喻。

注:文中的参数名和方法名仅用作对注释的说明,请勿对命名的规范性深究。

那么,iOS中的代码注释都有那些呢?

通用的注释:

//这是一条注释

/*这也是一条注释*/


参数的注释:

后面两种方便我们在使用参数的时候可以方便的看到注释,更直接更明白。


方法的注释:

 

 


方法区分:

#pragma mark 方法区分

#pragma mark – 方法区分

区别:- 横线会多一条分割线。


辅助注释:

在编译的时候会产生错误信息或警告信息。

#error 这里是错误信息

#warning 这里是警告信息


特殊注释:

//TODO:待处理

//FIXME:待修复

//!!!:重要信息

//???:这是问题

如果需要在编译的时候对这些注释产生警告,那么就需要我们多一步处理。

展开刚出现那一栏Run Script,输入以下内容

这样编译的时候就会产生我们想要的效果。


类注释:

类注释在创建的时候Xcode已经帮我们设置好了大部分。

当然对于版本,类的作用等描述性信息,如有需要自己可以另行添加。


代码注释工具:

XToDo   下载编译后重启,在View -> Snippets中可以快速插入TODO、FIXME、!!!、??? 注释,同时还有快捷键使用。

 

结束语:

注释虽好,可不要滥用哦。

 

尊重原创内容,转载请注明出处
本文链接地址: https://www.awnlab.com/archives/79

为您推荐

发表评论

电子邮件地址不会被公开。 必填项已用*标注