javascript文档注释

triumph

triumph

文档注释

JSDoc 注释规范

简介

是个根据js文件中注释信息,生成js应用程序或模板的API文档工具。可以使用:命名空间、类、方法、变量、方法功能等。能便于使用API,降低维护成本,提高开发效率。

文档注释规则

文档注释一般放在方法或函数生命之前,必须以/**开头,以便JSDoc解析器识别。

/**
* 加法运算
* @param {number} num1 数字1
* @param {number} num2 数字2
* @returns 返回加法的结果
*/
function add(num1,num2){
return num1 + num2;
}

[关于JSDoc更多内容](https://jsdoc.zcopy.site/)