來源 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的是一個人,熟悉了一套后,接入第二個平臺就快點了
其他
如果功能非常的多,可以考慮分包。