4. 适当添加注释
如果像官方的 API 那样,所有地方都添加注释,那工作量就太大了,需要额外的开发时间,如果只是针对一些语义不明、有歧义的代码添加注释,反而会减少开发时间。
例如一个属性:
@property (nonatomic, assign) int64_t createTime;
一看就知道是指创建时间,但它到底是不是时间戳?如果是时间戳,那单位是秒还是毫秒?如果还要打印数据以后才能下结论,就太耗时间了。
加上注释以后,它就一目了然了
/// 创建时间(时间戳 秒)
@property (nonatomic, assign) int64_t createTime;