【原文地址】Framework Design Guidelines: Naming New Versions of Existing APIs
【原文发表日期】08 December 08 06:57
承接我们每周对框架设计规范第二版中新增部分的系列博文。该内容能在第三章命名指![]()
南中的命名已存在API的新版本这一节找到。对也已存在并且是经常使用的API递增式的改进是一件艰难的工作。我个人从该规范(和Kit的解释)中学到的就是在第一次的时候就做好。
当使用64位整型代替32位整形来引进API的新版本时,请使用"64"后缀。只有当已经存在32位的API时才需要采用这种方法,对只有64位版本的全新API则不需要这样做。
举个例子,System.Diagnostics.Process中有许多API返回Int32值来表示内存大小,比如已分页内存大小或峰值工作集大小。为了在64位系统上也支持这些API,一些有相同名字但是带“64”后缀的API被加了进来。
public class Process {
// 已有的APIs
public int PeakWorkingSet { get; }
public int PagedMemorySize { get; }
// …
// 新版本的API
public long PeakWorkingSet64 { get; }
public long PagedMemorySize64 { get; }
}
KIT GEORGE
注意这条规范仅适用于对已经发布的API进行改造。当设计一个全新的API时,对那些将工作在所有平台上的API,使用最合适的类型和名称,并且避免同时使用“32”和“64”后缀。考虑使用重载。
打印 | 张贴于 2009-01-12 22:47:52 | Tag:New Guideline
留言反馈