14.接口与API设计

1、使用前缀避免命名空间冲突

选择与你、你公司、应用程序或与之皆关联之名作为类名的前缀,并在所有代码(类名, 方法, 分类, 函数)中使用这一前缀。

2、提供全能初始化方法

在类中提供一个全能初始化方法(NS_DESIGNATED_INITIALIZER),其他初始化方法均应调用此方法。
若全能初始化方法与超类不同,则需覆写超类中对应方法。
如果超类的初始化方法不适用子类,那么应该覆写超类方法,并在其中抛出异常。

3、实现description方法

1.实现description方法为类返回一个有意义的字符串,用于描述该实例。以字典形式打印更好。

- (NSString *)description {
    return [NSString stringWithFormat:@"<%@: %p, %@>",
            [self class],
            self,
            @{
              @"title" : _title,
              @"latitude" : @(_latitude),
              @"longitude" : @(_longitude),
              }
            ];
}

以命令行形式打印: po object
打印出时debugDescription方法返回的字符串。

4、尽量不适用可变对象

尽量创建不可变的对象
若某属性仅限于对象内部修改,则在分类中将readonly修改为readwrite
不要把可变的collection作为属性公开,而应提供相关方法,以此来修改对象中的可变collection。

5、使用清晰而协调的命名方式

起名时应该遵循标准的Objective-C命名规范,这样创建出来的接口更容易为开发者所接受。(类名、方法名、属性、协议、变量)
方法名要言简意赅,从左到右读取来像日常用语中的句子才好
方法名里不要使用缩略后的类型名称
---->形成风格

6、为私有方法名加前缀

给私有方法名加上前缀,这样可以很容易将其同公共方法区分开来
不要用单一的下划线做私有方法的前缀,这种做法是预留给苹果公司用的

你可能感兴趣的:(14.接口与API设计)