Contents
  1. 1. 好API的6个特质
    1. 1.1. 极简(Minimal)
    2. 1.2. 完备(Complete)
    3. 1.3. 语义清晰简单(Have clear and simple semantics)
    4. 1.4. 符合直觉(Be intuitive)
    5. 1.5. 易于记忆(Be easy to memorize)
    6. 1.6. 引导API使用者写出可读代码(Lead to readable code)

一致、易于掌握和强大的API是Qt最著名的优点之一。此文总结了我们在设计Qt风格API的过程中所积累的诀窍(know-how)。其中许多是通用准则;而其他的则更偏向于约定,遵循这些约定主要是为了与已有的API保持一致。

虽然这些准则主要用于对外的API(public API),但在设计对内的API(private API)时也推荐遵循相同的技巧(techniques),作为开发者之间协作的礼仪(courtesy)。

好API的6个特质

API之于程序员就如同图形界面之于普通用户(end-user)。API中的『P』实际上指的是『程序员』(Programmer),而不是『程序』(Program),强调的是API是给程序员使用的这一事实。

在第13期Qt季刊,Matthias 的关于API设计的文章中提出了观点:API应该极简(minimal)且完备(complete)、语义清晰简单(have clear and simple semantics)、符合直觉(be intuitive)、易于记忆(be easy to memorize)和引导API使用者写出可读代码(lead to readable code)。

极简(Minimal)

极简的API是指每个class的public成员尽可能少,public的class也尽可能少。这样的API更易理解、记忆、调试和变更。

完备(Complete)

完备的API是指期望有的功能都包含了。这点会和保持API极简有些冲突。如果一个成员函数放在错误的类中,那么这个函数的潜在用户就会找不到,这也是违反完备性的。

语义清晰简单(Have clear and simple semantics)

就像其他的设计一样,我们应该遵守最少意外原则(the principle of least surprise)。好的API应该可以让常见的事完成的更简单,并有可以完成不常见的事的可能性,但是却不会关注于那些不常见的事。解决的是具体问题;当没有需求时不要过度通用化解决方案。

符合直觉(Be intuitive)

就像计算机里的其他事物一样,API应该符合直觉。对于什么是符合直觉的什么不符合,不同经验和背景的人会有不同的看法。API符合直觉的测试方法:经验不很丰富的用户不用阅读API文档就能搞懂API,而且程序员不用了解API就能看明白使用API的代码。

易于记忆(Be easy to memorize)

为使API易于记忆,API的命名约定应该具有一致性和精确性。使用易于识别的模式和概念,并且避免用缩写。

引导API使用者写出可读代码(Lead to readable code)

代码只写一次,却要多次的阅读(还有调试和修改)。写出可读性好的代码有时候要花费更多的时间,但对于产品的整个生命周期来说是节省了时间的。

Contents
  1. 1. 好API的6个特质
    1. 1.1. 极简(Minimal)
    2. 1.2. 完备(Complete)
    3. 1.3. 语义清晰简单(Have clear and simple semantics)
    4. 1.4. 符合直觉(Be intuitive)
    5. 1.5. 易于记忆(Be easy to memorize)
    6. 1.6. 引导API使用者写出可读代码(Lead to readable code)