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的是一个人,熟悉了一套后,接入第二个平台就快点了

其他

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,133评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,682评论 3 390
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,784评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,508评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,603评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,607评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,604评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,359评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,805评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,121评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,280评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,959评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,588评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,206评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,442评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,193评论 2 367
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,144评论 2 352

推荐阅读更多精彩内容

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