* @return {{x: Number, y: Number}} * The location of the event */ var getEventLocation = function(e, type) { ... return {x: xLocation, y: yLocation}; } 虽然解析成功,但生成的文档仅说明: Returns: The location of an event Type: Object 我正在开发一个 API,需要人们了解他们将...
*/ function add(a, b = 0) { return a + b; } 描述对象属性:用于描述对象属性的类型和用途。 /** * @typedef {object} User * @property {string} name - 用户名。 * @property {number} age - 年龄。 */ 7. 类和构造函数:可以使用 @class 标记和 @constructor 标记来描述类和构造函数。
* @param {string} str2 - 第二个字符串 * @return {string} 连接后的字符串 */ functionconcatenate(str1,str2) { returnstr1+str2; } /** * @method * @param {object} obj - 被操作的对象 * @param {string} key - 要删除的键 */ functionremoveKey(obj,key) { deleteobj[key]; }...
问JSDoc:返回对象结构EN/** * @class Point * @type {Object} * @property {number} ...
如果存在，返回数字，否则返回的是 false。 而很多时候我们拿这个函数用来判断字符串中是否存在某个字符...
// 弱类型functiona(p){if(typeofp==='object'){returnObject.keys(p);}elseif(typeofp==='number'){returnp%10;}elseif(typeofp==='string'){returnp.length;}}// 项目中functiongetLengthOfArray(p){if(Array.isArray(p)){returnp.length;}return0;} ...
return true; } 关键JSDoc标签 与JavaDoc进行对比: 描述(Description):注释块的第一部分,用于总体描述函数、类或变量。 @param {type} name - description:类似JavaDoc的@param,但JSDoc中的{type}非常重要,它为动态的JavaScript参数提供了类型信息。 类型可以是基本类型 (string,number,boolean,Object,Array),也可以...
所以可以采用另一种描述Object中各项的描述,如下 /** * demo *@param{Object}a*@param{string} a.name 回复人的名字 *@param{number} a.age 回复人的年龄 *@returns{number} */functionfoo(a) {return2; } WebStorm 效果 可以看到注释和类型,非常的不错 ...
return self; }, /** * 获取指定索引值的队列中的文件 * @param {Number} index 文件在队列中的索引 * @return {Object} */ getFile:function (index) { if (!S.isNumber(index)) return false; var self = this, files = self.get('files'), ...
*@param{Object[]}persons- 人的集合 *@param{string} persons[].name - TA 的名字 *@param{number} persons[].age - TA 的年龄 *@param{number} [persons[].gender] - TA 的性别 */functionobjFunc(persons) {if(Array.isArray(persons)) { ...