javascript - 使用 JSDoc-3.3.0-alpha5 记录原型(prototype)属性和方法

Question

我有一个名为 FileDownloader 的类我已经尝试记录它，但是使用 prototype 声明的属性和方法不会在输出文件中生成。

如标题所述，我使用的是 jsdoc 3.3.0-alpha5。

代码如下:

/**
 * @class
 * @memberOf module:utils
 */
FileDownloader = function() {};    
/**
 * @type {Boolean}
 */
FileDownloader.prototype.overwrite = false;
/**
 * @type {String}
 */
FileDownloader.prototype.dir = config.dealImagePath;    
/**
 * @param {String} url
 * @param {Function} done
 * @param {Object} done.err
 * @param {String} done.file
 */
FileDownloader.prototype.download = function(url, done) {
    //...
};

这是生成的文档:

new FileDownloader()
    | Source: path/to/file.js

有什么想法吗？

Answer 1

原因是FileDownloader 描述中的memberOf。 您应该先设置模块，文件中的所有符号都被假定为模块的成员。 http://usejsdoc.org/tags-module.html

像这样

/** @module utils */

/**
 * @class
 */
var FileDownloader = function() {};

/**
 * @type {Boolean}
 */
FileDownloader.prototype.overwrite = false;
...