优秀的代码大部分是可以自描述的,我们完全可以用代码本身来表达它到底在干什么,而不需要注释的辅助。
但并不是说一定不能写注释,有以下三种情况比较适合写注释:
公共接口(注释要告诉阅读代码的人,当前类能实现什么功能)。
涉及到比较深层专业知识的代码(注释要体现出实现原理和思想)。
容易产生歧义的代码(但是严格来说,容易让人产生歧义的代码是不允许存在的)。
除了上述这三种情况,如果别人只能依靠注释才能读懂你的代码的时候,就要反思代码出现了什么问题。
最后,对于注释的内容,相对于“做了什么”
,更应该说明“为什么这么做”
。
如果有一个以上的import
语句,就对这些语句进行分组,每个分组的注释是可选的。
写在属性之后,用两个空格隔开
==例:==
一个函数(方法)必须有一个字符串文档来解释,除非它:
1,非公开,私有函数。
2,很短。
3,显而易见。
而其余的,包括公开接口,重要的方法,分类,以及协议,都应该伴随文档(注释):
1,以/开始
2,第二行是总结性的语句
3,第三行永远是空行
4,在与第二行开头对齐的位置写剩下的注释。
建议这样写:
方法的注释使用Xcode
自带注释快捷键:Commond+option+/
==例:==
单行的用//+空格
开头,多行的采用/* */
注释
使用//TODO:说明
标记一些未完成的或完成的不尽如人意的地方
==例:==