eryar

PipeCAD - Plant Piping Design Software.
RvmTranslator - Translate AVEVA RVM to OBJ, glTF, etc.
posts - 603, comments - 590, trackbacks - 0, articles - 0

Discoverable in API Design

Posted on 2013-10-10 23:22 eryar 阅读(2146) 评论(0)  编辑 收藏 引用

Avoiding the use of abbreviations can also play a factor in discoverability for API design.

可探索的API就是用户自己可以知道怎样使用API而不需要任何附加解释或文档。有些方法可以在你设计API时提高API的可探索性。设计一个直观和逻辑性强的对象模型是一个重要方式,因为为类和函数选择了好的名字。不过,取一个清晰、达意及合适的名字确实是API设计中最困难的任务啦。我在第4章中推荐了几种方法,但避免使用缩写在提高API的可探索性中也是一个重要因素,这样用户就不需要记住你的API是使用GetCurrentValue(), GetCurrValue(), GetCurValue(), 还是GetCurVal()啦。这一点深有体会,有时想缩写来减少敲键盘的次数,但缩写后也是会有对API的使用区分不清楚的时候。最好是做好数据字典,在API中全部使用全称,这样就舒服啦。


只有注册用户登录后才能发表评论。
网站导航: 博客园   IT新闻   BlogJava   知识库   博问   管理