> JSDoc在线手册 > @deprecated

@deprecated


描述: 说明这已不再是首选方法。

Syntax(语法)

@deprecated [<some text>]

Overview(概述)

@deprecated 标签指明一个标识在你代码中已经被弃用。

Examples(例子)

您可以单独使用的@deprecated标签,或包括一些文本,来详细说明为什么要弃用。

例如,描述一个old函数从2.0版本开始已经被弃用:

/**
 * @deprecated since version 2.0
 */
function old() {
}

上一篇:
下一篇: