JSDoc in action

JSDoc in action

JSDoc

https://jsdoc.app/index.html

https://github.com/jsdoc/jsdoc

$ npm  -g jsdoc

$ npm i -D jsdoc

demo

https://jsdoc.app/tags-returns.html

https://blog.jiasm.org/2019/04/22/使用JSDoc提高代码的可读性/

---

VSCode

https://code.visualstudio.com/docs/languages/javascript#_jsdoc-support

/**

/**
 * 
 * @param {*} a 
 * @param {*} b 
 */


/**
 * @description
 * @author xgqfrms
 * @param {*} a
 * @param {*} b
 * @returns 
 */

/** */

function add(a, b) {
    return a + b;
}

OK

/** */

/**
 * 
 * @param {number} a 
 * @param {number} b 
 */


/**
 * @description
 * @author xgqfrms
 * @param {number} a
 * @param {number} b
 * @returns 
 */


function add(a, b) {
    return a + b;
}

add()

Bad

/**
 * 
 * @param {number} a 
 * @param {number} b 
 */


/**
 * @description
 * @author xgqfrms
 * @param {number} a
 * @param {number} b
 * @returns 
 */

/** */

function add(a, b) {
    return a + b;
}

add()

refs

---

---

©xgqfrms 2012-2020

www.cnblogs.com 发布文章使用：只允许注册用户才可以访问！

---