common 下部分模块 api 可选参数优化 review by songym

Author: liqian7

src/common/commontypes/BaseTypes.js

@@ -4,11 +4,10 @@
  */
 
 /**
- * @description In addition to the mandatory C and P parameters, an arbitrary number of
- * objects can be passed, which will extend C.
+ * @description 除了 C 和 P 两个必要参数外，可以传递任意数量的对象，这些对象都将继承C。
  * @memberOf SuperMap
- * @param {Object} C - the class that inherits
- * @param {Object} P - the superclass to inherit from
+ * @param {Object} C - 继承的类。
+ * @param {Object} P - 被继承的父类。
  */
 SuperMap.inherit = function (C, P) {
     var F = function () {
@@ -27,9 +26,9 @@ SuperMap.inherit = function (C, P) {
 
 
 /**
- * @description 实现多重继承
+ * @description 实现多重继承。
  * @memberOf SuperMap
- * @param {Class|Object} ...mixins - 继承的类
+ * @param {Class|Object} ...mixins - 继承的类。
  */
 SuperMap.mixin = function (...mixins) {
 
@@ -74,44 +73,44 @@ SuperMap.mixin = function (...mixins) {
  * @name String
  * @memberOf SuperMap
  * @namespace
- * @description 字符串操作的一系列常用扩展函数.
+ * @description 字符串操作的一系列常用扩展函数。
  */
 export var StringExt = SuperMap.String = {
 
     /**
-     * @description 判断目标字符串是否以指定的子字符串开头.
-     * @param {string} str - 目标字符串.
-     * @param {string} sub - 查找的子字符串.
-     * @returns {boolean} 目标字符串以指定的子字符串开头，则返回true；否则返回false。
+     * @description 判断目标字符串是否以指定的子字符串开头。
+     * @param {string} str - 目标字符串。
+     * @param {string} sub - 查找的子字符串。
+     * @returns {boolean} 目标字符串以指定的子字符串开头，则返回 true；否则返回 false。
      */
     startsWith: function (str, sub) {
         return (str.indexOf(sub) == 0);
     },
 
     /**
-     * @description 判断目标字符串是否包含指定的子字符串.
-     * @param {string} str - 目标字符串.
-     * @param {string} sub - 查找的子字符串.
-     * @returns {boolean} 目标字符串中包含指定的子字符串,则返回true；否则返回false.
+     * @description 判断目标字符串是否包含指定的子字符串。
+     * @param {string} str - 目标字符串。
+     * @param {string} sub - 查找的子字符串。
+     * @returns {boolean} 目标字符串中包含指定的子字符串，则返回 true；否则返回 false。
      */
     contains: function (str, sub) {
         return (str.indexOf(sub) != -1);
     },
 
     /**
-     * @description 删除一个字符串的开头和结尾处的所有空白字符.
-     * @param {string} str - (可能)存在空白字符填塞的字符串.
-     * @returns {string} 删除开头和结尾处空白字符后的字符串.
+     * @description 删除一个字符串的开头和结尾处的所有空白字符。
+     * @param {string} str - （可能）存在空白字符填塞的字符串。
+     * @returns {string} 删除开头和结尾处空白字符后的字符串。
      */
     trim: function (str) {
         return str.replace(/^\s\s*/, '').replace(/\s\s*$/, '');
     },
 
     /**
-     * @description 骆驼式("-")连字符的字符串处理.
+     * @description 骆驼式("-")连字符的字符串处理。
      * 例如: "chicken-head" becomes "chickenHead",
-     *       "-chicken-head" becomes "ChickenHead".
-     * @param {string} str - 要处理的字符串,原始内容不应被修改.
+     *       "-chicken-head" becomes "ChickenHead"。
+     * @param {string} str - 要处理的字符串，原始内容不应被修改。
      * @returns {string}
      */
     camelize: function (str) {
@@ -125,7 +124,7 @@ export var StringExt = SuperMap.String = {
     },
 
     /**
-     * @description 提供带 ${token} 标记的字符串, 返回context对象属性中指定标记的属性值.
+     * @description 提供带 ${token} 标记的字符串, 返回 context 对象属性中指定标记的属性值。
      * @example
      * 示例:
      * (code)
@@ -155,10 +154,10 @@ export var StringExt = SuperMap.String = {
      *         args = null;
      *       返回值:"${a.b}"
      * (end)
-     * @param {string} template - 带标记的字符串将要被替换.参数 template 格式为"${token}",此处的 token 标记会替换为 context["token"] 属性的值
-     * @param {Object} context - 带有属性的可选对象的属性用于匹配格式化字符串中的标记.如果该参数为空,将使用 window 对象.
-     * @param {Array} args - 可选参数传递给在context对象上找到的函数.
-     * @returns {string} 从 context 对象属性中替换字符串标记位的字符串.
+     * @param {string} template - 带标记的字符串将要被替换。参数 template 格式为"${token}"，此处的 token 标记会替换为 context["token"] 属性的值。
+     * @param {Object} [context=window] - 带有属性的可选对象的属性用于匹配格式化字符串中的标记。如果该参数为空，将使用 window 对象。
+     * @param {Array} [args] - 可选参数传递给在 context 对象上找到的函数。
+     * @returns {string} 从 context 对象属性中替换字符串标记位的字符串。 
      */
     format: function (template, context, args) {
         if (!context) {
@@ -205,7 +204,7 @@ export var StringExt = SuperMap.String = {
     },
 
     /**
-     * @description Used to find tokens in a string.
+     * @description 寻找带 token 的字符串。
      * @example
      * Examples: ${a}, ${a.b.c}, ${a-b}, ${5}
      */
@@ -217,23 +216,23 @@ export var StringExt = SuperMap.String = {
     numberRegEx: /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/,
 
     /**
-     * @description 判断一个字符串是否只包含一个数值.
+     * @description 判断一个字符串是否只包含一个数值。
      * @example
      * (code)
      * SuperMap.String.isNumeric("6.02e23") // true
      * SuperMap.String.isNumeric("12 dozen") // false
      * SuperMap.String.isNumeric("4") // true
      * SuperMap.String.isNumeric(" 4 ") // false
      * (end)
-     * @returns {boolean} 字符串包含唯一的数值,返回true;否则返回false.
+     * @returns {boolean} 字符串包含唯一的数值，返回 true；否则返回 false。
      */
     isNumeric: function (value) {
         return SuperMap.String.numberRegEx.test(value);
     },
 
     /**
-     * @description 把一个看似数值型的字符串转化为一个数值.
-     * @returns {(number|string)} 如果能转换为数值则返回数值,否则返回字符串本身.
+     * @description 把一个看似数值型的字符串转化为一个数值。
+     * @returns {(number|string)} 如果能转换为数值则返回数值，否则返回字符串本身。
      */
     numericIf: function (value) {
         return SuperMap.String.isNumeric(value) ? parseFloat(value) : value;
@@ -245,29 +244,29 @@ export var StringExt = SuperMap.String = {
  * @name Number
  * @memberOf SuperMap
  * @namespace
- * @description 数值操作的一系列常用扩展函数.
+ * @description 数值操作的一系列常用扩展函数。
  */
 export var NumberExt = SuperMap.Number = {
 
     /**
-     *  @description 格式化数字时默认的小数点分隔符.
+     *  @description 格式化数字时默认的小数点分隔符。
      *  @constant
      *  @default "."
      */
     decimalSeparator: ".",
 
     /**
-     *  @description 格式化数字时默认的千位分隔符.
+     *  @description 格式化数字时默认的千位分隔符。
      *  @constant
      *  @default ","
      */
     thousandsSeparator: ",",
 
     /**
-     * @description 限制浮点数的有效数字位数.
-     * @param {number} num - 浮点数
-     * @param {integer} sig - 有效位数
-     * @returns {number} 将数字四舍五入到指定数量的有效位数.
+     * @description 限制浮点数的有效数字位数。
+     * @param {number} num - 浮点数。
+     * @param {integer} sig - 有效位数。
+     * @returns {number} 将数字四舍五入到指定数量的有效位数。
      */
     limitSigDigs: function (num, sig) {
         var fig = 0;
@@ -278,12 +277,12 @@ export var NumberExt = SuperMap.Number = {
     },
 
     /**
-     * @description 数字格式化输出.
-     * @param {number} num - 数字
-     * @param {integer} dec  - 数字的小数部分四舍五入到指定的位数.默认为 0. 设置为null值时小数部分不变.
-     * @param {string} tsep - 千位分隔符. 默认为",".
-     * @param {string} dsep - 小数点分隔符. 默认为".".
-     * @returns {string} 数字格式化后的字符串.
+     * @description 数字格式化输出。
+     * @param {number} num - 数字。
+     * @param {integer} [dec=0]  - 数字的小数部分四舍五入到指定的位数。设置为 null 值时小数部分不变。
+     * @param {string} [tsep=','] - 千位分隔符。
+     * @param {string} [dsep='.'] - 小数点分隔符。
+     * @returns {string} 数字格式化后的字符串。
      */
     format: function (num, dec, tsep, dsep) {
         dec = (typeof dec != "undefined") ? dec : 0;
@@ -328,9 +327,9 @@ if (!Number.prototype.limitSigDigs) {
     /**
      * APIMethod: Number.limitSigDigs
      * 限制浮点数的有效数字位数.
-     * @param {integer} sig -有效位数
-     * @returns {integer} 将数字四舍五入到指定数量的有效位数.
-     *           如果传入值为 null、0、或者是负数, 返回值 0
+     * @param {integer} sig -有效位数。
+     * @returns {integer} 将数字四舍五入到指定数量的有效位数。
+     *           如果传入值 为 null、0、或者是负数, 返回值 0。
      */
     Number.prototype.limitSigDigs = function (sig) {
         return NumberExt.limitSigDigs(this, sig);
@@ -341,14 +340,14 @@ if (!Number.prototype.limitSigDigs) {
  * @name Function
  * @memberOf SuperMap
  * @namespace
- * @description 函数操作的一系列常用扩展函数.
+ * @description 函数操作的一系列常用扩展函数。
  */
 export var FunctionExt = SuperMap.Function = {
     /**
-     * @description 绑定函数到对象.方便创建this的作用域.
-     * @param {function} func - 输入函数.
-     * @param {Object} object - 对象绑定到输入函数(作为输入函数的this对象).
-     * @returns {function} object参数作为func函数的this对象.
+     * @description 绑定函数到对象。方便创建 this 的作用域。
+     * @param {function} func - 输入函数。
+     * @param {Object} object - 对象绑定到输入函数（作为输入函数的 this 对象）。
+     * @returns {function} object 参数作为 func 函数的 this 对象。
      */
     bind: function (func, object) {
         // create a reference to all arguments past the second one
@@ -364,9 +363,9 @@ export var FunctionExt = SuperMap.Function = {
     },
 
     /**
-     * @description 绑定函数到对象,在调用该函数时配置并使用事件对象作为第一个参数.
-     * @param {function} func - 用于监听事件的函数.
-     * @param {Object} object - this 对象的引用.
+     * @description 绑定函数到对象，在调用该函数时配置并使用事件对象作为第一个参数。
+     * @param {function} func - 用于监听事件的函数。
+     * @param {Object} object - this 对象的引用。
      * @returns {function}
      */
     bindAsEventListener: function (func, object) {
@@ -376,7 +375,7 @@ export var FunctionExt = SuperMap.Function = {
     },
 
     /**
-     * @description 该函数仅仅返回false.该函数主要是避免在IE8以下浏览中DOM事件句柄的匿名函数问题.
+     * @description 该函数仅仅返回 false。该函数主要是避免在 IE8 以下浏览中 DOM 事件句柄的匿名函数问题。
      * @example
      * document.onclick = SuperMap.Function.False;
      * @returns {boolean}
@@ -386,7 +385,7 @@ export var FunctionExt = SuperMap.Function = {
     },
 
     /**
-     * @description 该函数仅仅返回true.该函数主要是避免在IE8以下浏览中DOM事件句柄的匿名函数问题.
+     * @description 该函数仅仅返回 true。该函数主要是避免在 IE8 以下浏览中 DOM 事件句柄的匿名函数问题。
      * @example
      * document.onclick = SuperMap.Function.True;
      * @returns {boolean}
@@ -396,7 +395,7 @@ export var FunctionExt = SuperMap.Function = {
     },
 
     /**
-     * @description 可重用函数,仅仅返回"undefined".
+     * @description 可重用函数，仅仅返回 "undefined"。
      * @returns {undefined}
      */
     Void: function () {
@@ -408,19 +407,19 @@ export var FunctionExt = SuperMap.Function = {
  * @name Array
  * @memberOf SuperMap
  * @namespace
- * @description 数组操作的一系列常用扩展函数.
+ * @description 数组操作的一系列常用扩展函数。
  */
 export var ArrayExt = SuperMap.Array = {
 
     /**
-     * @description 过滤数组.提供了ECMA-262标准中Array.prototype.filter函数的扩展.
+     * @description 过滤数组，提供了 ECMA-262 标准中 Array.prototype.filter 函数的扩展。
      * @see {@link http://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/Array/filter}
-     * @param {Array} array - 要过滤的数组.
-     * @param {function} callback - 数组中的每一个元素调用该函数.<br>
-     *     如果函数的返回值为true,该元素将包含在返回的数组中.该函数有三个参数: 数组中的元素,元素的索引,数组自身.<br>
-     *     如果设置了可选参数caller,在调用callback时,使用可选参数caller设置为callback的参数.<br>
-     * @param {Object} caller - 在调用callback时，使用可选参数caller设置为callback的参数。
-     * @returns {Array} callback函数返回true时的元素将作为返回数组中的元素。
+     * @param {Array} array - 要过滤的数组。
+     * @param {function} callback - 数组中的每一个元素调用该函数。
+     *     如果函数的返回值为 true，该元素将包含在返回的数组中。该函数有三个参数: 数组中的元素，元素的索引，数组自身。
+     *     如果设置了可选参数 caller，在调用 callback 时，使用可选参数 caller 设置为 callback 的参数。
+     * @param {Object} [caller] - 在调用 callback 时，使用参数 caller 设置为 callback 的参数。
+     * @returns {Array} callback 函数返回 true 时的元素将作为返回数组中的元素。
      */
     filter: function (array, callback, caller) {
         var selected = [];