javascript - 如何使用JSDoc记录对象？

使用JSDoc记录简单JavaScript对象（及其导出）的源代码的最佳方法是什么？

例如，我要记录以下对象：

/** how do I JSDocument object baseAdder? */
const baseAdder  = {
    /** how do I JSDocument property base? */
    base: 1,
    /**
     * Add a number to base
     * @param {number} a the number to be added to base
     * @returns {number} the sum of the number plus base
     */
    f: function(a) {
        return this.base + a;
        }
    };

/** how do I JSDocument this export? Should I? */
module.exports = baseAdder;

最佳答案

基本的JS Doc文档就像。

/*
* {Object} baseAdder - Base Adder object
* {Number} baseAdder.base - Base value
* {function} baseAdder.f - A function f on the Base Adder
*/
const baseAdder  = {
    base: 1,
    /**
     * Add a number to base
     * @param {Number} - a the number to be added to base
     * @returns {Number} - the sum of the number plus base
     */
    f: function(a) {
        return this.base + a;
        }
    };

/**
 * A module of base adder!
 * @module baseAdder
 */
module.exports = baseAdder;

有关更多参考，请遵循官方文档-http://usejsdoc.org/index.html

关于javascript - 如何使用JSDoc记录对象？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/53122176/