不要修改這樣的約定。比如前端要處理多種語言html,css,js本來要記得東西都夠多的啦。不要引入一些不必要的改變,使工作變得複雜。就像在css中我們在描述矩形的四條邊的參數時,總是以上右下左的順序。因為這個和margin,padding等屬性約定相同順序。如果違反了這個約定,頁面表現一定會出錯。 ...
對於api使用者來說,你所使用的命名和函數簽名是最能產生普遍影響的決策。這些約定很重要具有巨大的影響力。它建立了基本的辭彙和使用它們的應用程式的慣用法。庫的使用者必須學會閱讀和使用這些。一致的約定可以讓人更容易理解和記憶。
參數順序
參數順序的約定很重要。如,用戶界面庫通常具有一些接收多個測量值(寬,高)的函數。確保這些參數總是以相同的順序出現。選擇和其它常用庫的參數順序相同,可以方便用戶使用,如第一個參數是寬度,第二個參數是高度。
var widget=new Widget(320,240);
除非有特殊的要求,要不就不要修改這樣的約定。比如前端要處理多種語言html,css,js本來要記得東西都夠多的啦。不要引入一些不必要的改變,使工作變得複雜。就像在css中我們在描述矩形的四條邊的參數時,總是以上右下左的順序。因為這個和margin,padding等屬性約定相同順序。如果違反了這個約定,頁面表現一定會出錯。
選項對象參數
因為這裡有參數是一個對象,所以裡面對應項的順序就沒有這麼重要了。重要的是每一項的鍵值的命名,及後面參數的格式。
詳盡的文檔
每一個優秀的庫都需要詳盡的文檔,而一個極優秀的庫將文檔作為輔助。一旦你的用戶用熟了庫,他們可以不再依賴於文檔而自由使用。一致的約定可以幫助用戶推測一個方法的行為。
提示
-
在變數命名和函數簽名中使用一致的約定
-
不要偏離用戶在他們的開發平臺中很可能遇到的約定