我應該如何命名我的javascript庫函數，以便它們可以與普通的舊javascript區分開來？

Question

我正在js中編寫自定義UI構建器。 它使用工廠的實現來構建元素。 為了確保哪些函數是庫的一部分而哪些是普通的舊javascript的一部分，我使用了function _FunctionName()的命名約定。 但是，我發現總是做Factory._FunctionName()很乏味。

我應該刪除命名約定（ function FunctionName() ）還是堅持它？

是否有關於制作這樣的庫的命名約定常見/最佳實踐？

編輯：

var __PanelFactory = function () {
 //"private"
 var Panels = [];
 //exposed
 function _GetPanel(id) {
  //etc
 }
 return {
    _GetPanel: _GetPanel,
 };
};

var Factory = new __PanelFactory();
Factory. //this will show certain plain javascript functions 
         //like toString, constructor, hasOwnProperty, isPrototypeOf, etc...

//note that even jQuery can have the previous list used with something like
$(selector).

//So to differentiate I made sure my functions start with _
Factory._GetPanel(1);

//Should I just make it easy on myself and allow
Factory.GetPanel(1);

//Or is there value in leaving the naming convention in?

Answer 1

以下是javascript中一些非常常見的約定。

常量

通常在ALL_CAPS_WITH_UNDERSCORES中

var MAX_COUNT = 100;
var BASE_URL = "http://example.com/api/";

變量

通常在lowerCamelCase中

var currentCount = 0;
var userName = "timrwood";

構造函數

通常在UpperCamelCase中

function Factory(){}
var factory = new Factory();

方法

通常在lowerCamelCase中

Factory.prototype.getPanel = function(){};
var factory = new Factory();
var panel = factory.getPanel();

私人變量/方法

通常在_lowerCamelCaseWithAUnderscorePrefix中;

Factory.prototype._fetchPanel = function(){};
Factory.prototype.getPanel = function() {
    return this._fetchPanel();
}

Answer 2

SO上已經有一個問題鏈接到關於Javscript編碼約定（包括命名）的好文檔：

• javascript命名約定
• http://javascript.crockford.com/code.html

你問過的關鍵部分：

• 使用名稱空間（帶有初始名稱）。

這在某種程度上是可選的，因為PanelFactory不會與普通的Javascript沖突。 如果您要使第三方使用公共API，它可能會與其他庫發生沖突，但是：

var MyApp = MyApp || {};
MyApp.__PanelFactory = function () { // ...

• 在所有函數名稱之前刪除下划線（ _ ）。

您不需要下划線，因為已經使用JavaScript一段時間的人知道每個對象（ toString等）中內置的默認實例范圍函數：

MyApp.PanelFactory = function () {
  // ...
  function GetPanel(id) {
    //etc
  }

• 使用initial-caps名稱命名對象構造函數，但命名全局或命名空間范圍的函數和具有初始小寫名稱的實例范圍函數：

這只是一個標准慣例。 它無法區分內置函數，但正如我在上一個項目中所說，您不需要。

MyApp.PanelFactory = function () {
  // ...
  function getPanel(id) {
    //etc
  }

• 使用初始小寫名稱命名局部變量：

這將幫助您區分命名空間，對象構造函數和對象的實例（您希望存在自定義實例范圍的函數，通常稱為“方法”）。

var factory = new MyApp.PanelFactory();
var panel = factory.getPanel();