overview

为了标准模块对外提供正当的 api，现整顿如下准则：

若干准则

作者承责准则

作者对 api 负责。承当好用、不好用带来的后果。
负责迭代更新。

作者优先准则

作者开发的 api 应该先满足作者的需要。

不听从用户优先准则

不以用户为核心开发 api。用户能应用的 api 都是作者已开发的 api。
作者决定开发哪些 api。用户决定应用哪些 api。
用户有使用权。用户能够抉择应用或不应用。能够提倡议。不可决定 api。
此准则是“作者优先准则”的另一种表白。

实用准则

每个 api 必须能够实现肯定性能。

繁多准则

每个 api 只实现一个性能。

合乎自然规律准则

这条很重要，然而我不晓得如何形容。

防止适度重载准则

每个 api 能够有肯定重载能力。然而不应该适度重载。此准则相似“繁多准则”。

肯定容错准则

当 api 收到一些不影响运行的数据或通过解决后能够运行的数据时应该失常返回后果。

严格数据优先准则

当有更严格的数据时应该优先应用此数据。
如：严格的数据类型、限定应用范畴的数据。

灵便优先准则

在某同一个实现后果上有多个 api 管制时，应该应用灵活性更大的数据去实现。

独立优先准则

各 api 间应该缩小重叠管制。尽量做到每个 api 管制一个性能。减小多个 api 管制一个性能的状况。

语义准则

命名 api 时应该做到见文知意。