JSDoc 不打印自定义类型的参数 (typedef)

Question

我通过 @typedef:

定义了自定义类型

/**
 * @typedef {Object} FILE_DATA
 * @property {NodeJS.ReadableStream} fileStream
 * @property {string} fileUUID
 */

然后我在方法签名中应用这个自定义类型：

/**
 * Upload file to Dropbox
 *
 * @param {FILE_DATA} fileData - file data to be stored
 * @returns {Promise<Readonly<{fileName: string, folderUUID: string, isSucceeded: boolean, message: string}>>} file upload result
 */
export const fileUpload = async function fileUpload(fileData) {…}

当我生成 JSDoc 时，我希望 fileUpload() 文档将包含自定义类型，实际上关于 fileUpload() 的唯一文档是：

(static, constant) fileUpload
Upload file to Dropbox

如何使 JSDoc 显示有关 fileUpload() 的更多详细信息？

Answer 1

要解决此问题，请务必向函数 fleUpload:

添加注释 @function/@method

/**
 * Upload file to Dropbox
 *
 * @function
 * @param {FILE_DATA} fileData - file data to be stored
 * @returns {Promise<Readonly<{fileName: string, folderUUID: string, isSucceeded: boolean, message: string}>>} file upload result
 */
export const fileUpload = async function fileUpload(fileData) {

添加此注释后，JSDoc 将 fileUpload 置于方法而非成员之下。

JSDoc 不打印自定义类型的参数 (typedef)

JSDoc doesn't print a param of a custom type (typedef)

jsdoc

jsdoc3