js注释：JSDoc注释和函数注释

原创已于 2024-05-10 10:59:24 修改 · 522 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#笔记

于 2024-04-11 11:31:52 首次发布

javeScript 专栏收录该内容

2 篇文章

订阅专栏

本文详细介绍了JavaScript中常见的注释标签，如@name用于命名、@param和@returns用于函数参数和返回值说明，以及@description、@typedef和@example的用法。还涵盖了过时(@deprecated)、忽略(@ignore)和继承文档(@inheritdoc)的特性。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

常用的注释一般是前面 5个

/**
*@name: 标记可以用于为一个模块、类或命名空间提供名称 。

*@param {type} paramName - Description: 描述函数的参数。{type}表示参数的类型，paramName表示参数名，Description表示参数的描述。

*@returns {type} Description: 描述函数的返回值。{type}表示返回值的类型，Description表示返回值的描述。

*@description Description: 描述函数或者变量的功能、作用等信息。

*@typedef {type} Name - Description: 定义一个新的类型。{type}表示类型，Name表示类型的名称，Description表示类型的描述。

*@example Example: 提供示例代码。
 * var result = add(1, 2);
 * console.log(result); // 输出: 3

*@deprecated: 标记已过时的函数、变量等。

*@ignore: 忽略某些部分的文档化。

*@inheritdoc: 继承父类的文档。

*@inheritdoc: 继承父类的文档。

*/