购物车
登陆 / 注册
微信扫码登陆

推荐手册

@typedef

描述: 记录一个自定义的类型

语法

@typedef [<type>] <namepath>

概述

@typedef标签在描述自定义类型时是很有用的,特别是如果你要反复引用它们的时候。这些类型可以在其它标签内使用,如 @type @param

使用@callback标签表明回调函数的类型。

例子

这个例子定义了一个联合类型的参数,表示可以包含数字或字符串。

例如,使用@typedef标签:

/**
 * A number, or a string containing a number.
 * @typedef {(number|string)} NumberLike
 */
 /**
 * Set the magic number.
 * @param {NumberLike} x - The magic number.
 */
 function setMagicNumber(x) {
}

本实例定义了一个更复杂的类型,一个对象的几个属性,并设置其namepath(名称路径) 所以使用该类型将与类一起显示。由于该类型定义实际上不是由类暴露, 习惯上,以记录类型定义作为内部构件。

使用@typedef记录的复杂类型的一类,例如:

/**
 * The complete Triforce, or one or more components of the Triforce.
 * @typedef {Object} WishGranter~Triforce
 * @property {boolean} hasCourage - Indicates whether the Courage component is present.
 * @property {boolean} hasPower - Indicates whether the Power component is present.
 * @property {boolean} hasWisdom - Indicates whether the Wisdom component is present.
 */
 /**
 * A class for granting wishes, powered by the Triforce.
 * @class
 * @param {...WishGranter~Triforce} triforce - One to three {@link WishGranter~Triforce} objects
 * containing all three components of the Triforce.
 */
 function WishGranter() {}
网站导航
标签地图
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
技术文章
文档工具
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ官方交流群
微信公众号
微信公众号