【VSCode插件】VS DocBlockr 便捷的生成 JS文档注释
VS DocBlockr是有 atom 中的DocVlockr的VSCode 移植版。
我最开始在html中试用发现不能在.HTML文件中使用,只能做.Js文件中使用(可能是我使用的方式有问题)。
文档注释标准参考内容:
JavaScript 开发规范(一): 命名与注释规范详解(2.4 函数(方法)注释)
示例代码:
/**
* 测试方法
*
* @param {String} params 默认参数
* @param {Boolean} admin 管理员参数
*
* @return {Number} 0
*
* @author onemue 2020-12-14
* @version 0.3
*
* @example text("I am test function!");
*/
function test(params, admin) {
console.log(params);
}
test();
示例图: