设计Public API

为Library设计Public API, 是一件非常困难的事。

设计Public API, Interface, 命名API, Interface 相当于给你的小孩取名一样。

主要原则是:
1. 易简单

2. 名字易清晰
可以稍微长一点,而不让使用这个API的程序员糊涂。
用长度来换取清晰,是可取的。

4. 通用方式
Action + Object
Action + 形容词 + Object
Action + 形容词 + Object + 副词
以及这样形式的多种组成.


如: DrawLine, WaitOneObject, beginthreadex


3. 大小写标准
internal api, 多半为:  _APIName
public API 前面多半不加: _
形式多半为:  WordWordWord ... 的形式
每个词的首字母大写.


4. 参数不易多
参数多半在 0~8个之间。


5. 多重重载引出的多样参数
如果使用GDI+, 可以使用DrawImage, 有15种以上之多的参数形式。

 

你可能感兴趣的:(System)