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