[Effective JavaScript 筆記]第53條:保持一致的約定

来源:http://www.cnblogs.com/wengxuesong/archive/2016/07/01/5633581.html
-Advertisement-
Play Games

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


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

參數順序

參數順序的約定很重要。如,用戶界面庫通常具有一些接收多個測量值(寬,高)的函數。確保這些參數總是以相同的順序出現。選擇和其它常用庫的參數順序相同,可以方便用戶使用,如第一個參數是寬度,第二個參數是高度。

var widget=new Widget(320,240);

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

選項對象參數

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

詳盡的文檔

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

提示

  • 在變數命名和函數簽名中使用一致的約定

  • 不要偏離用戶在他們的開發平臺中很可能遇到的約定


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • ZooKeeper 是 Apache 的一個頂級項目,為分散式應用提供高效、高可用的分散式協調服務,提供了諸如數據發佈/訂閱、負載均衡、命名服務、分散式協調/通知和分散式鎖等分散式基礎服務。由於 ZooKeeper 便捷的使用方式、卓越的性能和良好的穩定性,被廣泛地應用於諸如 Hadoop、HBas... ...
  • 隨著唯品會業務的快速發展,訂單量的不斷增長,原有的訂單存儲架構已經不能滿足公司的發展了,特別是在大促高峰期,原訂單庫已經成為搶購瓶頸,已經嚴重製約公司的發展。 唯品會舊訂單庫包含幾十張訂單相關表,舊訂單庫是典型的一主多從架構;主庫容量已接近伺服器物理空間上限,同時也已經達到MySQL的處理上限,很快 ...
  • 現 在主流的Web MVC框架除了Struts這個主力 外,其次就是Spring MVC了,因此這也是作為一名程式員需要掌握的主流框架,框架選擇多了,應對多變的需求和業務時,可實行的方案自然就多了。不過要想靈活運用Spring MVC來應對大多數的Web開發,就必須要掌握它的配置及原理下載地址 。 ...
  • 在《JavaScript設計模式》介紹中,裝飾者模式跟Mixin(混入)模式相比,是另一種可行的對象子類化(Mixin模式乾的事)的替代方案。 裝飾者(Decorator)模式 定義: 給對象動態添加額外的功能。向基本對象添加(裝飾)屬性或方法,而不是進行子類化,它較為精簡。 使用場景: java ...
  • 介面,強大,簡單,交互,跨越平臺 下麵簡單闡述這兩大介面思想 一 REST: REST是一種架構風格,其核心是面向資源,REST專門針對網路應用設計和開發方式,以降低開發的複雜性,提高系統的可伸縮性。 REST提出設計概念和準則為: 1.網路上的所有事物都可以被抽象為資源(resource) 2.每 ...
  • 一、前言 AgileEAS.NET SOA 中間件平臺是一款基於基於敏捷並行開發思想和Microsoft .Net構件(組件)開發技術而構建的一個快速開發應用平臺。用於幫助中小型軟體企業建立一條適合市場快速變化的開發團隊,以達到節省開發成本、縮短開發時間,快速適應市場變化的目的。 AgileEAS. ...
  • 簡介 用於實現伺服器(Linux)的訪問控制的功能的。 分硬體和軟體防火牆。 主要是控制訪問的流入和伺服器的流出。 通過黑名單和白名單的思想來實現更細粒度的控制,這個一般結合其他的應用來定義策略實現。 概念 黑白名單 可以說防禦的思想,主要就是黑白名單的思想!!!!是黑白名單的組合。 黑名單指的是對 ...
  • 本文為原創文章,轉載請註明出處,謝謝 zookeeper自帶腳本使用 1、進入zookeeper客戶端 找到安裝目錄下的bin目錄,執行以下腳本(中括弧標示被必填) ./zkCli.sh -timeout 5000 [-r] -server 127.0.0.1:2181 (-r指伺服器掛掉仍可提供讀 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...