[Effective JavaScript 筆記]第53條：保持一緻的約定

不要修改這樣的約定。比如前端要處理多種語言html,css,js本來要記得東西都夠多的啦。不要引入一些不必要的改變，使工作變得複雜。就像在css中我們在描述矩形的四條邊的參數時，總是以上右下左的順序。因為這個和margin,padding等屬性約定相同順序。如果違反了這個約定，頁面表現一定會出錯。

對于api使用者來說，你所使用的命名和函數簽名是最能産生普遍影響的決策。這些約定很重要具有巨大的影響力。它建立了基本的詞彙和使用它們的應用程式的慣用法。庫的使用者必須學會閱讀和使用這些。一緻的約定可以讓人更容易了解和記憶。

參數順序

參數順序的約定很重要。如，使用者界面庫通常具有一些接收多個測量值（寬，高）的函數。確定這些參數總是以相同的順序出現。選擇和其它常用庫的參數順序相同，可以友善使用者使用，如第一個參數是寬度，第二個參數是高度。

var widget=new Widget(320,240);
           

除非有特殊的要求，要不就不要修改這樣的約定。比如前端要處理多種語言html,css,js本來要記得東西都夠多的啦。不要引入一些不必要的改變，使工作變得複雜。就像在css中我們在描述矩形的四條邊的參數時，總是以上右下左的順序。因為這個和margin,padding等屬性約定相同順序。如果違反了這個約定，頁面表現一定會出錯。

選項對象參數

因為這裡有參數是一個對象，是以裡面對應項的順序就沒有這麼重要了。重要的是每一項的鍵值的命名，及後面參數的格式。

詳盡的文檔

每一個優秀的庫都需要詳盡的文檔，而一個極優秀的庫将文檔作為輔助。一旦你的使用者用熟了庫，他們可以不再依賴于文檔而自由使用。一緻的約定可以幫助使用者推測一個方法的行為。

提示

• 在變量命名和函數簽名中使用一緻的約定
• 不要偏離使用者在他們的開發平台中很可能遇到的約定

版權聲明

翻譯的文章，版權歸原作者所有，隻用于交流與學習的目的。

原創文章，版權歸作者所有，非商業轉載請注明出處，并保留原文的完整連結。