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

Documenting prototype property and method with JSDoc-3.3.0-alpha5

本文关键字：属性 方法 原型 记录 JSDoc-3 0-alpha5 使用      更新时间：2023-09-26

我有一个名为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

任何想法?

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

这样的

/** @module utils */
/**
 * @class
 */
var FileDownloader = function() {};
/**
 * @type {Boolean}
 */
FileDownloader.prototype.overwrite = false;
...
相关文章：