chore: change comments of example

jajugoguma · jajugoguma · commit cb8c39416bad · 2021-05-28T16:58:09.000+09:00
chore: let to const
diff --git a/ajax/index.mjs b/ajax/index.mjs
@@ -353,9 +353,14 @@ function send(xhr, options) {
  * @param {string} [options.mimeType] - Override the MIME type returned by the server. This options can be used on IE11+
  * @returns {?Promise} - If the browser supports Promise, return the Promise object. If not, return null.
  * @example
- * import ajax from 'tui-code-snippet/ajax'; // import ES6 module (written in ES6)
- * // import ajax from 'tui-code-snippet/ajax/index.js'; // import transfiled file (IE8+)
- * // const ajax = require('tui-code-snippet/ajax/index.js'); // CommonJS
+ * // ES6
+ * import ajax from 'tui-code-snippet/ajax';
+ *
+ * // import transfiled file (IE8+)
+ * import ajax from 'tui-code-snippet/ajax/index.js';
+ *
+ * // CommonJS
+ * const ajax = require('tui-code-snippet/ajax/index.js');
  *
  * // If the browser supports Promise, return the Promise object
  * ajax({
diff --git a/array/inArray.js b/array/inArray.js
@@ -23,8 +23,11 @@ var isArray = require('../type/isArray');
  * @returns {number} the First index at which a given element, or -1 if it is not present
  * @memberof module:array
  * @example
- * import inArray from 'tui-code-snippet/array/inArray'; // ES6
- * // const inArray = require('tui-code-snippet/array/inArray'); // CommonJS
+ * // ES6
+ * import inArray from 'tui-code-snippet/array/inArray';
+ * 
+ * // CommonJS
+ * const inArray = require('tui-code-snippet/array/inArray');
  *
  * const arr = ['one', 'two', 'three', 'four'];
  * const idx1 = inArray('one', arr, 3); // -1
diff --git a/array/range.js b/array/range.js
@@ -15,8 +15,11 @@ var isUndefined = require('../type/isUndefined');
  * @returns {Array}
  * @memberof module:array
  * @example
- * import range from 'tui-code-snippet/array/range'; // ES6
- * // const range = require('tui-code-snippet/array/range'); // CommonJS
+ * // ES6
+ * import range from 'tui-code-snippet/array/range';
+ * 
+ * // CommonJS
+ * const range = require('tui-code-snippet/array/range');
  *
  * range(5); // [0, 1, 2, 3, 4]
  * range(1, 5); // [1,2,3,4]
diff --git a/array/zip.js b/array/zip.js
@@ -13,10 +13,13 @@ var forEach = require('../collection/forEach');
  * @returns {Array}
  * @memberof module:array
  * @example
- * import zip from 'tui-code-snippet/array/zip'; // ES6
- * // const zip = require('tui-code-snippet/array/zip'); // CommonJS
+ * // ES6
+ * import zip from 'tui-code-snippet/array/zip';
+ * 
+ * // CommonJS
+ * const zip = require('tui-code-snippet/array/zip');
  *
- * const result = zip([1, 2, 3], ['a', 'b','c'], [true, false, true]);
+ * const result = zip([1, 2, 3], ['a', 'b', 'c'], [true, false, true]);
  * console.log(result[0]); // [1, 'a', true]
  * console.log(result[1]); // [2, 'b', false]
  * console.log(result[2]); // [3, 'c', true]
diff --git a/browser/browser.js b/browser/browser.js
@@ -14,8 +14,11 @@
  * This object has an information that indicate the kind of browser. It can detect IE8 ~ IE11, Chrome, Firefox, Safari, and Edge.
  * @memberof module:browser
  * @example
+ * // ES6
  * import browser from 'tui-code-snippet/browser/browser';
- * // const browser = require('tui-code-snippet/browser/browser'); // CommonJS
+ * 
+ * // CommonJS
+ * const browser = require('tui-code-snippet/browser/browser'); 
  *
  * browser.chrome === true; // chrome
  * browser.firefox === true; // firefox
diff --git a/collection/forEach.js b/collection/forEach.js
@@ -26,8 +26,11 @@ var forEachOwnProperties = require('../collection/forEachOwnProperties');
  * @param {Object} [context] Context(this) of callback function
  * @memberof module:collection
  * @example
- * import forEach from 'tui-code-snippet/collection/forEach'; // ES6
- * // const forEach = require('tui-code-snippet/collection/forEach'); // CommonJS
+ * // ES6
+ * import forEach from 'tui-code-snippet/collection/forEach'; 
+ * 
+ * // CommonJS
+ * const forEach = require('tui-code-snippet/collection/forEach'); 
  *
  * let sum = 0;
  *
diff --git a/collection/forEachArray.js b/collection/forEachArray.js
@@ -18,8 +18,11 @@
  * @param {Object} [context] Context(this) of callback function
  * @memberof module:collection
  * @example
- * import forEachArray from 'tui-code-snippet/collection/forEachArray'; // ES6
- * // const forEachArray = require('tui-code-snippet/collection/forEachArray'); // CommonJS
+ * // ES6
+ * import forEachArray from 'tui-code-snippet/collection/forEachArray';
+ * 
+ * // CommonJS
+ * const forEachArray = require('tui-code-snippet/collection/forEachArray'); 
  *
  * let sum = 0;
  *
diff --git a/collection/forEachOwnProperties.js b/collection/forEachOwnProperties.js
@@ -17,8 +17,11 @@
  * @param {Object} [context] Context(this) of callback function
  * @memberof module:collection
  * @example
- * import forEachOwnProperties from 'tui-code-snippet/collection/forEachOwnProperties'; // ES6
- * // const forEachOwnProperties = require('tui-code-snippet/collection/forEachOwnProperties'); // CommonJS
+ * // ES6
+ * import forEachOwnProperties from 'tui-code-snippet/collection/forEachOwnProperties';
+ * 
+ * // CommonJS
+ * const forEachOwnProperties = require('tui-code-snippet/collection/forEachOwnProperties'); 
  *
  * let sum = 0;
  *
diff --git a/collection/pluck.js b/collection/pluck.js
@@ -14,8 +14,11 @@ var forEach = require('./forEach');
  * @returns {Array}
  * @memberof module:collection
  * @example
- * import pluck from 'tui-code-snippet/collection/pluck'; // ES6
- * // const pluck = require('tui-code-snippet/collection/pluck'); // CommonJS
+ * // ES6
+ * import pluck from 'tui-code-snippet/collection/pluck'; 
+ * 
+ * // CommonJS
+ * const pluck = require('tui-code-snippet/collection/pluck'); 
  *
  * const objArr = [
  *   {'abc': 1, 'def': 2, 'ghi': 3},
diff --git a/collection/toArray.js b/collection/toArray.js
@@ -14,8 +14,11 @@ var forEachArray = require('./forEachArray');
  * @returns {Array} Array
  * @memberof module:collection
  * @example
- * import toArray from 'tui-code-snippet/collection/toArray'; // ES6
- * // const toArray = require('tui-code-snippet/collection/toArray'); // CommonJS
+ * // ES6
+ * import toArray from 'tui-code-snippet/collection/toArray'; 
+ * 
+ * // CommonJS
+ * const toArray = require('tui-code-snippet/collection/toArray'); 
  *
  * const arrayLike = {
  *   0: 'one',
diff --git a/customEvents/customEvents.js b/customEvents/customEvents.js
@@ -18,9 +18,11 @@ var R_EVENTNAME_SPLIT = /\s+/g;
 /**
  * @class
  * @example
- * // node, commonjs
- * import CustomEvents from 'tui-code-snippet/customEvents/customEvents'; // ES6
- * // const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); // CommonJS
+ * // ES6
+ * import CustomEvents from 'tui-code-snippet/customEvents/customEvents';
+ * 
+ * // CommonJS
+ * const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); 
  */
 function CustomEvents() {
   /**
@@ -39,16 +41,18 @@ function CustomEvents() {
  * Mixin custom events feature to specific constructor
  * @param {function} func - constructor
  * @example
- * import CustomEvents from 'tui-code-snippet/customEvents/customEvents'; // ES6
- * // const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); // CommonJS
+ * //ES6
+ * import CustomEvents from 'tui-code-snippet/customEvents/customEvents'; 
+ * 
+ * // CommonJS
+ * const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); 
  *
- * let model;
  * function Model() {
  *     this.name = '';
  * }
  * CustomEvents.mixin(Model);
  *
- * model = new Model();
+ * const model = new Model();
  * model.on('change', function() { this.name = 'model'; }, this);
  * model.fire('change');
  * alert(model.name); // 'model';
@@ -207,8 +211,11 @@ CustomEvents.prototype._bindEvent = function(eventName, handler, context) {
  * @param {(function|object)} [handler] - handler function or context
  * @param {object} [context] - context for binding
  * //-- #1. Get Module --//
- * import CustomEvents from 'tui-code-snippet/customEvents/customEvents'; // ES6
- * // const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); // CommonJS
+ * // ES6
+ * import CustomEvents from 'tui-code-snippet/customEvents/customEvents'; 
+ * 
+ * // CommonJS
+ * const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); 
  *
  * //-- #2. Use method --//
  * // # 2.1 Basic Usage
@@ -441,8 +448,11 @@ CustomEvents.prototype._offByObject = function(obj, handler) {
  * @param {(function)} handler - handler function
  * @example
  * //-- #1. Get Module --//
- * import CustomEvents from 'tui-code-snippet/customEvents/customEvents'; // ES6
- * // const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); // CommonJS
+ * // ES6
+ * import CustomEvents from 'tui-code-snippet/customEvents/customEvents'; 
+ * 
+ * // CommonJS
+ * const CustomEvents = require('tui-code-snippet/customEvents/customEvents'); 
  *
  * //-- #2. Use method --//
  * // # 2.1 off by event name
diff --git a/defineClass/defineClass.js b/defineClass/defineClass.js
@@ -22,9 +22,12 @@ var extend = require('../object/extend');
  *  @param {Object} [props.static] Static members of constructor
  * @returns {*} Constructor
  * @memberof module:defineClass
- * @exampl
- * import defineClass from 'tui-code-snippet/defineClass/defineClass'; // ES6
- * // const defineClass = require('tui-code-snippet/defineClass/defineClass'); // CommonJS
+ * @example
+ * // ES6
+ * import defineClass from 'tui-code-snippet/defineClass/defineClass'; 
+ * 
+ * // CommonJS
+ * const defineClass = require('tui-code-snippet/defineClass/defineClass'); 
  *
  * //-- #2. Use property --//
  * const Parent = defineClass({
diff --git a/domUtil/template.js b/domUtil/template.js
@@ -344,8 +344,11 @@ function compile(sources, context) {
  * @returns {string} - text that bind with its context
  * @memberof module:domUtil
  * @example
- * import template from 'tui-code-snippet/domUtil/template'; // ES6
- * // const template = require('tui-code-snippet/domUtil/template'); // CommonJS
+ * // ES6
+ * import template from 'tui-code-snippet/domUtil/template'; 
+ * 
+ * // CommonJS
+ * const template = require('tui-code-snippet/domUtil/template'); 
  * 
  * const source = 
  *     '<h1>'
diff --git a/enum/enum.js b/enum/enum.js
@@ -2,8 +2,8 @@
  * @fileoverview This module provides a Enum Constructor.
  * @author NHN FE Development Lab <dl_javascript@nhn.com>
  * @example
- * // node, commonjs
- * var Enum = require('tui-code-snippet/enum/enum');
+ * // CommonJS
+ * const Enum = require('tui-code-snippet/enum/enum');
  */
 
 'use strict';
@@ -44,7 +44,8 @@ var enumValue = 0;
  * @class
  *
  * @example
- * const Enum = require('tui-code-snippet/enum/enum'); // node, commonjs
+ * // CommonJS
+ * const Enum = require('tui-code-snippet/enum/enum');
  *
  * const MYENUM = new Enum('TYPE1', 'TYPE2');
  * const MYENUM2 = new Enum(['TYPE1', 'TYPE2']);
diff --git a/formatDate/formatDate.js b/formatDate/formatDate.js
@@ -147,8 +147,11 @@ function isValidDate(year, month, date) { // eslint-disable-line complexity
  * // minutes         | m / mm
  * // meridiem(AM,PM) | A / a
  *
- * import formatDate from 'tui-code-snippet/formatDate/formatDate'; // ES6
- * // const formatDate = require('tui-code-snippet/formatDate/formatDate'); // CommonJS
+ * // ES6
+ * import formatDate from 'tui-code-snippet/formatDate/formatDate'; 
+ * 
+ * // CommonJS
+ * const formatDate = require('tui-code-snippet/formatDate/formatDate'); 
  *
  * const dateStr1 = formatDate('yyyy-MM-dd', {
  *   year: 2014,
diff --git a/inheritance/inherit.js b/inheritance/inherit.js
@@ -16,8 +16,11 @@ var createObject = require('./createObject');
  * @param {function} superType Parent constructor
  * @memberof module:inheritance
  * @example
- * import inherit from 'tui-code-snippet/inheritance/inherit'; // ES6
- * // const inherit = require('tui-code-snippet/inheritance/inherit'); // CommonJS
+ * // ES6
+ * import inherit from 'tui-code-snippet/inheritance/inherit';
+ * 
+ * // CommonJS
+ * const inherit = require('tui-code-snippet/inheritance/inherit');
  *
  * // Parent constructor
  * function Animal(leg) {
diff --git a/object/pick.js b/object/pick.js
@@ -15,8 +15,11 @@ var isNull = require('../type/isNull');
  * @returns {*} Value
  * @memberof module:object
  * @example
- * import pick from 'tui-code-snippet/object/pick'; // ES6
- * // const pick = require('tui-code-snippet/object/pick'); // CommonJS
+ * // ES6
+ * import pick from 'tui-code-snippet/object/pick';
+ * 
+ * // CommonJS
+ * const pick = require('tui-code-snippet/object/pick');
  *
  * cosnt obj = {
  *   'key1': 1,
diff --git a/request/imagePing.js b/request/imagePing.js
@@ -18,8 +18,11 @@ var forEachOwnProperties = require('../collection/forEachOwnProperties');
  * @returns {HTMLElement}
  * @memberof module:request
  * @example
- * import imagePing from 'tui-code-snippet/request/imagePing'; // ES6
- * // const imagePing = require('tui-code-snippet/request/imagePing'); // CommonJS
+ * // ES6
+ * import imagePing from 'tui-code-snippet/request/imagePing';
+ * 
+ * // CommonJS
+ * const imagePing = require('tui-code-snippet/request/imagePing');
  *
  * imagePing('https://www.google-analytics.com/collect', {
  *   v: 1,
diff --git a/string/decodeHTMLEntity.js b/string/decodeHTMLEntity.js
@@ -15,8 +15,11 @@
  * @returns {String} Plain string
  * @memberof module:string
  * @example
- * import decodeHTMLEntity from 'tui-code-snippet/string/decodeHTMLEntity'; // ES6
- * // const decodeHTMLEntity = require('tui-code-snippet/string/decodeHTMLEntity'); // CommonJS
+ * // ES6
+ * import decodeHTMLEntity from 'tui-code-snippet/string/decodeHTMLEntity';
+ * 
+ * // CommonJS
+ * const decodeHTMLEntity = require('tui-code-snippet/string/decodeHTMLEntity');
  *
  * const htmlEntityString = "A &#39;quote&#39; is &lt;b&gt;bold&lt;/b&gt;"
  * const result = decodeHTMLEntity(htmlEntityString); //"A 'quote' is <b>bold</b>"
diff --git a/string/encodeHTMLEntity.js b/string/encodeHTMLEntity.js
@@ -11,8 +11,11 @@
  * @returns {String} HTML Entity
  * @memberof module:string
  * @example
- * import encodeHTMLEntity from 'tui-code-snippet/string/encodeHTMLEntity'; // ES6
- * // const encodeHTMLEntity = require('tui-code-snippet/string/encodeHTMLEntity'); // CommonJS
+ * // ES6
+ * import encodeHTMLEntity from 'tui-code-snippet/string/encodeHTMLEntity';
+ * 
+ * // CommonJS
+ * const encodeHTMLEntity = require('tui-code-snippet/string/encodeHTMLEntity');
  *
  * const htmlEntityString = "<script> alert('test');</script><a href='test'>";
  * const result = encodeHTMLEntity(htmlEntityString);
diff --git a/tricks/debounce.js b/tricks/debounce.js
@@ -17,8 +17,11 @@
  * @returns {function} debounced function.
  * @memberof module:tricks
  * @example
- * import debounce from 'tui-code-snippet/tricks/debounce'; // ES6
- * // const debounce = require('tui-code-snippet/tricks/debounce'); // CommonJS
+ * // ES6
+ * import debounce from 'tui-code-snippet/tricks/debounce';
+ * 
+ * // CommonJS
+ * const debounce = require('tui-code-snippet/tricks/debounce');
  *
  * function someMethodToInvokeDebounced() {}
  *
diff --git a/tricks/throttle.js b/tricks/throttle.js
@@ -16,8 +16,11 @@ var debounce = require('./debounce');
  * @returns {function} throttled function
  * @memberof module:tricks
  * @example
- * import throttle from 'tui-code-snippet/tricks/throttle'; // ES6
- * // const throttle = require('tui-code-snippet/tricks/throttle'); // CommonJS
+ * // ES6
+ * import throttle from 'tui-code-snippet/tricks/throttle';
+ * 
+ * // CommonJS
+ * const throttle = require('tui-code-snippet/tricks/throttle');
  *
  * function someMethodToInvokeThrottled() {}
  *
diff --git a/type/isExisty.js b/type/isExisty.js
@@ -15,8 +15,11 @@ var isNull = require('./isNull');
  * @returns {boolean} Is existy?
  * @memberof module:type
  * @example
- * import isExisty from 'tui-code-snippet/type/isExisty'); // ES6
- * // const isExisty = require('tui-code-snippet/type/isExisty'); // CommonJS
+ * // ES6
+ * import isExisty from 'tui-code-snippet/type/isExisty');
+ * 
+ * // CommonJS
+ * const isExisty = require('tui-code-snippet/type/isExisty');
  *
  * isExisty(''); //true
  * isExisty(0); //true

Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,11 @@ var forEachOwnProperties = require('../collection/forEachOwnProperties');`
`26`	`26`	`* @param {Object} [context] Context(this) of callback function`
`27`	`27`	`* @memberof module:collection`
`28`	`28`	`* @example`
`29`		`- * import forEach from 'tui-code-snippet/collection/forEach'; // ES6`
`30`		`- * // const forEach = require('tui-code-snippet/collection/forEach'); // CommonJS`
	`29`	`+ * // ES6`
	`30`	`+ * import forEach from 'tui-code-snippet/collection/forEach';`
	`31`	`+ *`
	`32`	`+ * // CommonJS`
	`33`	`+ * const forEach = require('tui-code-snippet/collection/forEach');`
`31`	`34`	`*`
`32`	`35`	`* let sum = 0;`
`33`	`36`	`*`
Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,11 @@`
`18`	`18`	`* @param {Object} [context] Context(this) of callback function`
`19`	`19`	`* @memberof module:collection`
`20`	`20`	`* @example`
`21`		`- * import forEachArray from 'tui-code-snippet/collection/forEachArray'; // ES6`
`22`		`- * // const forEachArray = require('tui-code-snippet/collection/forEachArray'); // CommonJS`
	`21`	`+ * // ES6`
	`22`	`+ * import forEachArray from 'tui-code-snippet/collection/forEachArray';`
	`23`	`+ *`
	`24`	`+ * // CommonJS`
	`25`	`+ * const forEachArray = require('tui-code-snippet/collection/forEachArray');`
`23`	`26`	`*`
`24`	`27`	`* let sum = 0;`
`25`	`28`	`*`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,11 @@`
`17`	`17`	`* @param {Object} [context] Context(this) of callback function`
`18`	`18`	`* @memberof module:collection`
`19`	`19`	`* @example`
`20`		`- * import forEachOwnProperties from 'tui-code-snippet/collection/forEachOwnProperties'; // ES6`
`21`		`- * // const forEachOwnProperties = require('tui-code-snippet/collection/forEachOwnProperties'); // CommonJS`
	`20`	`+ * // ES6`
	`21`	`+ * import forEachOwnProperties from 'tui-code-snippet/collection/forEachOwnProperties';`
	`22`	`+ *`
	`23`	`+ * // CommonJS`
	`24`	`+ * const forEachOwnProperties = require('tui-code-snippet/collection/forEachOwnProperties');`
`22`	`25`	`*`
`23`	`26`	`* let sum = 0;`
`24`	`27`	`*`