写iOS SDK注意事项
来源:互联网 发布:怎么打开淘宝旗舰店 编辑:程序博客网 时间:2024/06/09 22:54
http://blog.devtang.com/2015/01/31/write-sdk-tips/
这个作者在这边提到了几点都是很重要的
一、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的是一个人,熟悉了一套后,接入第二个平台就快点了。
其他
如果功能非常的多,可以考虑分包。
0 0
- 写iOS SDK注意事项
- 写iOS SDK注意事项
- 写iOS SDK注意事项
- iOS 写SDK注意事项
- 写iOS SDK注意事项
- 写iOS SDK注意事项
- 写iOS SDK注意事项
- 开发iOS SDK注意事项
- 开发IOS SDK注意事项
- 【读书笔记】iOS-写代码注意事项
- iOS开发支付宝 集成SDK注意事项
- ios-支付宝支付sdk使用注意事项
- 后台给android,ios写接口注意事项
- 自己写的iOS BLE SDK
- 关于使用百度地图的IOS SDK 的注意事项
- iOS成长之AutoLayout写控件的注意事项
- GOMOBILE写Android和iOS移动端SDK
- 移动添加SDK注意事项
- AutoLayout框架Masonry使用心得
- Android AutoLayout全新的适配方式 堪称适配终结者
- 生成Ipa安装包的plist文件后生成下载链接
- 运算符
- SQL Server 问题解决
- 写iOS SDK注意事项
- NSDictionary和NSMutableDictionary整理与总结
- Oracle简介与安装
- SQL 几种JOIN用法实例
- Android API Guides---Drawable Animation
- 男闺蜜APP辅助刷话题应用之闺蜜刷
- 修改linux最大文件句柄数
- linux VSFTP配置
- Redis与Memcached的区别