js注释:JSDoc注释和函数注释

 常用的注释一般是前面 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: 继承父类的文档。

*/

  • 3
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值