[iOS-Objective-C] 注释

Cocoa 开发者间流传着一句格言,Objective-C 的冗长使得其代码就是有效的自我说明。有了[longMethodNamesWithNamedParameters:]以及参数的显式类型,Objective-C 的方法不会给人留下太多的想象空间。但即使是自我说明的代码也可以通过注释加以改进。那么 Objective-C 中的注释具体应该怎么写呢,总结起来说就是,不要写不该写的注释,不要省不该省的注释。

不该写的注释

  • 注释不应当解释代码在做什么,而是应该解释这段代码为什么要这样做。大多数情况下,解释每一步代码在做什么的注释是没有意义的,通过良好的编码规范和定义,变量名和方法名本身就可以是一种逻辑的解释,阅读者完全可以通过直接阅读代码知道这段代码做了什么,而解释只是简单的翻译了代码,重复了阅读者已经知道的内容,其实反而是增加了阅读者的阅读时间。
  • 被弃用的代码应该被删掉,这些代码会非常影响阅读,而且它们一般又很长。 在绝大多数情况下,被弃用的代码不会重新派上用场,即使出现了少数情况,你也可以从版本控制系统中找到它们

不该省的注释

  • 在业务代码中,只有当非常必要的情况下,才应该添加注释,而且应当言简意赅。比如有一段逻辑复杂的代码,通过阅读代码无法快速直接的了解其作用时,应当添加简明的注释。
  • 在上述不该写的注释中指出,对于代码执行步骤的解释型注释是冗余的,但如果一个类中的某一功能方法调用链很长时,可以在入口方法处写一些简明的注释,说明整个操作做了什么工作,这类注释可以对整个类的功能块进行划分,使阅读者可以快速有整体的了解,而具体的实现,则通过方法名和代码逻辑说明。
  • 还有一类注释是接口注释,就是把要暴露出来的元素都写上详细的注释,一般用于供别人使用的框架或类库,这种注释的作用是让使用者在不需要看源码或无法看到源码的情况下,可以根据注释来使用。另外,这类注释一般可以被工具生成为文档。

在 Objective-C 中写注释

对复杂逻辑的解释备注,使用简单的单行注释即可。对于接口注释,从 Xcode8 开始,苹果已将插件VVDocumenter的功能集成进 Xcode 中,可通过快捷键 command + alt + / 快速生成注释模板。而且这类模板对 appledoc 的支持很好,可能只需要很小的改动,比如枚举的注释格式等。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,457评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,837评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,696评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,183评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,057评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,105评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,520评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,211评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,482评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,574评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,353评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,213评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,576评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,897评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,174评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,489评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,683评论 2 335

推荐阅读更多精彩内容