在函数中,需要写上注释,那么如何将一个函数的注释写的更完整呢?不仅有param,还有更多的例如作者信息author,函数返回值,表示示例信息...等等,下面会对注释内容进行详细的讲解。让您更详细的了解注释,而不是简单停留在 // /** */ 中。
下面我会以 addBook函数 和 发送网络请求 两个方式进行距离,代表是一个添加书籍的函数,参数含义:第一个参数title代表是书籍的标题,第二个参数author代表是书籍的作者,第三个参数func是为了测试是一个可选的函数参数。
在函数中,可以添加如下注释。
@author 可以填写你的姓名 <此处可以填写你的邮箱> 代表写此函数作者的一些信息
@param {*} title 文章的标题 (这些是参数的具体含义)