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

@example

@example
@example提供一个如何使用描述项的例子。跟随此标签的文字将显示为高亮代码。
编辑:青灯夜游 青灯夜游 更新时间:2019-01-15 17:52:06

@example

描述: 提供一个如何使用描述项的例子。

Overview(概述)

提供一个如何使用描述项的例子。跟随此标签的文字将显示为高亮代码。

Examples(例子)

注意,一个doclet中可以同时使用多个@example标签。

例如,描述多个示例:

/**
 * Solves equations of the form a * x = b
 * @example
 * // returns 2
 * globalNS.method1(5, 10);
 * @example
 * // returns 3
 * globalNS.method(5, 15);
 * @returns {Number} Returns the value of x for the equation.
 */
globalNS.method1 = function (a, b) {
    return b / a;
};

@example标签后面可以添加  标签作为示例的标题。

例如,带有标题的例子:

/**
 * Solves equations of the form a * x = b
 * @example <caption>Example usage of method1.</caption>
 * // returns 2
 * globalNS.method1(5, 10);
 * @returns {Number} Returns the value of x for the equation.
 */
globalNS.method1 = function (a, b) {
    return b / a;
};
网站导航
网站首页
学习路径
视频教程
开发软件
旗下子站
php中文网
phpstudy
文章列表
教程文档
关于我们
企业合作
人才招聘
联系我们
讲师招募
QQ交流群
QQ交流群
微信公众号
微信公众号