API设计小手册

C++ API 设计小手册

什么是好的API

前言

给想写类库的人。本文是vrcats按照一个Qt开发工程师写的《A Little Manual of API Design

API设计小手册

》翻译而成的。其中总结了多年Qt开发中关于API设计的一些经验和教训,提炼出了一系列关于API设计和面向对象类库设计的原则和方法论。水平很高,门槛不高,是vrcats目前看到的最好的关于C++API设计资料。

本文并非严格翻译。有许多段落思维太跳跃了不搭界,作了删节处理。有些例子不恰当的也作了一些修改,也加入了一点个人对API设计的理解。译者对于API 设计其实也是初哥,相信国内做API设计的也不多,从这方面资料的量就看得出来。翻译得虽然有点糙,总的思想不会错。全文万字左右,不长,大家慢慢咀嚼。发现错误回帖告诉我,我会及时更正。转贴请注明原始来源,译者和转自CuteQt。

目录:

简介 好的API长啥样 设计流程 设计原则

简介

API是应用编程接口的缩写。说白了就是开放给编程者的一堆符号,这样他们才能使用你的库。API设计是库设计中最难搞的一步,会影响到上层应用程序的结构。正如丹尼尔杰克逊大叔说的,软件就跟砍竹子是一样一样的,都那么抽象。你要找对了口儿就势如破竹,那叫顺水行舟一路狂奔,加新功能也不需要怎么大改。你要是一开始设计错了,那就两步一个坎三步一个疖子,等着无穷的惊讶吧。

本手册来自多年Qt开发的经验。设计的时候要仔细考虑API设计,同时兼顾实现难度和性能。甭管你是设计公用API还是本地库,这些规则都挺有用的。

好的API长啥样?

这个问题太主观。在跟一些大牛研究之后,大家一致认为好的API要有如下特点:

* 好学好记 * 看了就知道是干啥的 * 不容易用错 * 容易扩展升级 * 完整

API设计小手册相关文档

最新文档

返回顶部