在 JavaScript 中进行方法封装时,注释是良好文档和可读性的重要组成部分。以下是一些建议的 JavaScript 方法封装注释规范:
/**
* @function
* @description 计算两个数字的和
* @param {number} num1 - 第一个数字
* @param {number} num2 - 第二个数字
* @returns {number} - 两个数字的和
* @throws {Error} - 当输入不是数字时抛出错误
* @example
* const result = addNumbers(2, 3);
* console.log(result); // 输出: 5
* @see {@link https://example.com} - 相关文档链接
* @author Jam
*/
function addNumbers(num1, num2) {
if (typeof num1 !== 'number' || typeof num2 !== 'number') {
throw new Error('Both parameters must be numbers');
}
return num1 + num2;
}
在 JSDoc 中,有许多标签可用于对函数进行注释。这只是列举了一些常用的,其余没有一一列举
具体参考官方文档:
因篇幅问题不能全部显示,请点此查看更多更全内容
Copyright © 2019- huatuo0.cn 版权所有 湘ICP备2023017654号-2
违法及侵权请联系:TEL:199 1889 7713 E-MAIL:2724546146@qq.com
本站由北京市万商天勤律师事务所王兴未律师提供法律服务