前端代码规范

7.3注释规范
7.3.1单行注释
// console.log(‘这是单行注释’);
7.3.2多行注释
所有的函数均使用多行注释,并注释好对应的参数,提高代码的可阅读性.
@constructor 构造函数声明注释
@constructor明确一个函数是某个类的构造函数。
@param 参数注释
使用@param来表示函数、类的方法的参数,@param是JSDoc中最常用的注释标签。参数标签可表示一个参数的参数名、参数类型和参数描述的注释。
@return 返回值注释
@return表示一个函数的返回值,如果函数没有显示指定返回值可不写。

/**

  • Represents a book.
  • @constructor
  • @param {string} title - The title of the book.
  • @param {string} author - The author of the book.
    */
    function Book(title, author) {}
    如果想了解更多的 JSDoc 注释的内容,可参考下面的链接。
    JSDoc 文档 https://jsdoc.app/index.html
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值