接口和API设计

一.使用前缀避免命名空间冲突


!引用第三方库,同样需要进行添加项目前缀

二.提供全能初始化方法

!在类中提供全能初始化方法,并在文档中声明,所有初始化方法必须调用次方法。

!若全能初始化方法与父类不同,则需要重写父类的方法。

!若父类的全能初始化方法不适用时,应当重写,并抛出异常。

三.实现Description方法

!普通模式--重写description

!Debug模式--重写debugDescription

四.尽量使用不可变对象

!控制操作权限

!尽量创建不可变对象,并且不要公开不可变对象,提供相应的接口即可。

五.使用清晰而协调的命名方式

!遵循OC命名规则,简单易懂的描述该方法的功能。

!公开方法和私有方法加标记

六.减少使用异常抛出

!使用Error返回错误信息

你可能感兴趣的:(接口和API设计)