1783-HMS8TG8EG4CGN
1783-HMS8TG8EG4CGN 地构建SDK
1. 了解墙外的,把握好需求
试着去关注你的竞争对手或者与你相似领域的公司都做了什么。这可能会给你一些参考的角度。采纳你喜欢的地方,改善你不喜欢的地方。
2. 简洁
代码简洁——简洁的代码意味着你的客户用起来得心应手。这可能包括尽可能减少与代码交互的方式,比如只公开一个接口类;或是简短的方法签名,比如少量的输入参数,等等。
除了初始化阶段(只发生一次且可能要求进行配置),请让SDK方法使用起来尽可能简单。
同样地,请尽量减少方法签名中的参数。
你可以通过提供默认配置以及允许用户进行覆盖的默认实现类来达到这一目的。
隐藏用户不需要使用的类和方法,比如,只将用户使用的类/方法设定为公有的,否则就将它们的使用范围设定为局部或者私有。一个 IDEs 提供了代码检查与清除功能,可以帮你自动实现这一点。
参考文档简洁——让你的文档尽可能简单易懂。这意味着有时候你得多写注释,有时候又得尽量少写。内联样本代码通常很有帮助,因为大多数人都是通过例子来学习的。
1783-HMS8TG8EG4CGN