[英]Document named parameters with typedoc
How do I document named parameters with typedoc?如何使用 typedoc 记录命名参数? I have this JavaScript file:
我有这个 JavaScript 文件:
/**
* @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.我希望文档 output、类型和默认值显示在文档中。
However, neither of my attempts works, and the documentation is not helpful:但是,我的任何尝试都不起作用,并且文档没有帮助:
How can I document the foo
and bar
named parameters?如何记录
foo
和bar
命名参数?
Here is a repository demonstrating the problem.这是一个演示问题的存储库。
This seems to be a bug in typedoc.这似乎是 typedoc 中的一个错误。
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.