iOS SDK注意事项

来源 http://blog.csdn.net/ad_118/article/details/51180492

一、SDK中所有的类名都应该加前缀
二、所有Category加前缀
三、尽量不要引入第三方的库、如果引入要添加前缀

比如添加了NSData+Base64,可以把NSData+Base64改成NSData+KYBase64,在前面加KY或者自己公司的缩写、产品缩写

四、所有的提供的方法有测试例子,如果有多个模块功能,可以独立接入,尽量提供每个模块的单独demo。
五、文档的完整和正确
六、提供debug模式,输出必要的日志,特别是错误日志,且提供处理这个错误具体步骤

比如用户没有配置plist里面内容,不要只提示不能获取xx,
而是要提示:不能获取xx、请在info.plist中添加key为xxx value为xxx。

七、充分测试

每次更改都要充分测试,完全测试

八、提供的方法的易用性、简洁性

方法要“望文生义”
实现相同的功能的时候要尽量减少用户的操作,即减少方法的调用,能不用用户调用就不要让用户调用,能不让用户操作就不要让用户操作,自己内部解决。

九、尽量提供模拟器的支持

即使调用了第三方的SDK不支持模拟器,也可以通过判断是否为模拟器环境而决定要不要调用来提供支持

#if TARGET_IPHONE_SIMULATOR//模拟器

#elif TARGET_OS_IPHONE//真机

#endif
十、向下兼容

新版本SDK的API要兼容旧版本的API,在旧的API要加上deprecated,并提醒加入方这个是在未来某个时候是会弃用了,尽量使用新的API。

十一、不要太频繁的更新

如果SDK太频繁的更新,会让开发者不爽。

十二、尽量使Andriod和iOS的接口一致

关于iOS和Android的一些对外接口方法,宏定义,尽量相同。 有可能接入SDK的是一个人,熟悉了一套后,接入第二个平台就快点了

其他

如果功能非常的多,可以考虑分包。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • http://blog.devtang.com/2015/01/31/write-sdk-tips/
    weigegege阅读 1,748评论 0 0
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,798评论 19 139
  • 渐渐回归绿城的郑州 秋天正在南下的路上 我嗅到一丝熟悉的凉爽 就在道路的两旁 树树升腾起绿色的希望 把生命的力量颂...
    水仙书生阅读 1,098评论 0 2
  • 现在的社会,一个人不焦虑,都不好意思在社会上混!上到在大城市生活假装生活的中产阶级,下到进了985,211才发现自...
    精致的绵羊阅读 2,839评论 0 0
  • ​参考文章: http://blog.sina.com.cn/s/blog_7447a0160102wi51.ht...
    许你一枝花阅读 6,577评论 0 0