你的位置:首页 > Java教程

[Java教程][Effective JavaScript 笔记]第53条:保持一致的约定


对于api使用者来说,你所使用的命名和函数签名是最能产生普遍影响的决策。这些约定很重要具有巨大的影响力。它建立了基本的词汇和使用它们的应用程序的惯用法。库的使用者必须学会阅读和使用这些。一致的约定可以让人更容易理解和记忆。

参数顺序

参数顺序的约定很重要。如,用户界面库通常具有一些接收多个测量值(宽,高)的函数。确保这些参数总是以相同的顺序出现。选择和其它常用库的参数顺序相同,可以方便用户使用,如第一个参数是宽度,第二个参数是高度。

var widget=new Widget(320,240);

除非有特殊的要求,要不就不要修改这样的约定。比如前端要处理多种语言html,css,js本来要记得东西都够多的啦。不要引入一些不必要的改变,使工作变得复杂。就像在css中我们在描述矩形的四条边的参数时,总是以上右下左的顺序。因为这个和margin,padding等属性约定相同顺序。如果违反了这个约定,页面表现一定会出错。

选项对象参数

因为这里有参数是一个对象,所以里面对应项的顺序就没有这么重要了。重要的是每一项的键值的命名,及后面参数的格式。

详尽的文档

每一个优秀的库都需要详尽的文档,而一个极优秀的库将文档作为辅助。一旦你的用户用熟了库,他们可以不再依赖于文档而自由使用。一致的约定可以帮助用户推测一个方法的行为。

提示

  • 在变量命名和函数签名中使用一致的约定

  • 不要偏离用户在他们的开发平台中很可能遇到的约定