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() 的唯一文档是：

（静态，常量）文件上传
上传文件到 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 放在方法而不是成员之下。