javascript代碼規范

  • 注釋
// 文件注釋
/**
 * --------------------------------------------------
 * 文件描述:實現功能、模塊、接口、使用說明、范例
 * @version  版本號
 * @author   作者(聯系方式)
 * @date      文件創建日期
 * --------------------------------------------------
 **/

// 接口注釋
/**
 * --------------------------------------------------
 * 接口描述:實現功能、使用說明、范例
 * @param  {參數類型}  參數名稱
 * @return   {返回類型}
 * @author  作者(聯系方式)  *可選
 * @date     文件創建日期     *可選
 * --------------------------------------------------
 **/

// class注釋
/**
 * --------------------------------------------------
 * 功能描述:描述對象及基本功能、使用說明、范例
 * @class      當前class
 * @extends  繼承父class
 * @param    {參數類型}  參數名
 * @author    作者(聯系方式)  *可選
 * @date       文件創建日期     *可選
 * --------------------------------------------------
 **/
// 內部注釋
// 注釋內容
  • 命名
// 命名空間
首字母小寫
// class
首字母大寫
// 私有屬性/接口
__  前綴
// 公共屬性/接口
_$  前綴
// 變量
全局變量  g_
臨時變量/參數  _
// 常量
全部大寫字母
// 枚舉型
對象名大寫,枚舉量小寫
// 事件
加事件名稱后綴
// 方法
首字母小寫
  • 格式
// 空格
操作符前后空一格
逗號、分號、冒號后空一格
空行、空對象、空數組不填入空格
// 縮進
條件語句
聲明多個變量
多行數組元素
多行對象值
// 換行
表達式過長,合適位置換行
多參數,合適位置換行
匿名函數體
過長三元操作符
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容