简体   繁体   中英

Document named parameters with typedoc

How do I document named parameters with typedoc? I have this JavaScript file:

/**
 * @param {Number} foo An interesting value
 * @param {Number} __namedParameters.bar Another value
 */
function demo({ foo=42, bar=43 } = {}) { }

I would like the documentation output, types, and default values to show up in the documentation.

However, neither of my attempts works, and the documentation is not helpful:

typedoc 输出:__namedParameters:{} = {}

How can I document the foo and bar named parameters?

Here is a repository demonstrating the problem.

This seems to be a bug in typedoc.

The technical post webpages of this site follow the CC BY-SA 4.0 protocol. If you need to reprint, please indicate the site URL or the original address.Any question please contact:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM