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;
...

使用JSDoc-3.3.0-alpha5记录原型属性和方法

1 个答案: