JSDoc 中文网

语法

¥Syntax

@deprecated [<some text>]

概述

¥Overview

@deprecated 标记将代码中的符号标记为已弃用。

¥The @deprecated tag marks a symbol in your code as being deprecated.

示例

¥Examples

你可以单独使用 @deprecated 标记,或者包含一些描述有关弃用的更多信息的文本。

¥You can use the @deprecated tag by itself, or include some text that describes more about the deprecation.

记录旧函数自 2.0 版本起已被弃用
/**

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