JavaScript文档注释详解

本文介绍了如何为函数编写详细的注释,包括@author,@param,@return和@example等关键信息,以addBook函数和网络请求配置对象为例,阐述了参数、可选参数、返回值及示例的注释方式。
摘要由CSDN通过智能技术生成

在函数中,需要写上注释,那么如何将一个函数的注释写的更完整呢?不仅有param,还有更多的例如作者信息author,函数返回值,表示示例信息...等等,下面会对注释内容进行详细的讲解。让您更详细的了解注释,而不是简单停留在 // /** */ 中。

下面我会以 addBook函数发送网络请求 两个方式进行距离,代表是一个添加书籍的函数,参数含义:第一个参数title代表是书籍的标题,第二个参数author代表是书籍的作者,第三个参数func是为了测试是一个可选的函数参数。

在函数中,可以添加如下注释。

@author 可以填写你的姓名 <此处可以填写你的邮箱> 代表写此函数作者的一些信息

@param {*} title 文章的标题 (这些是参数的具体含义)

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值