Tag: jsdoc

如何使用内联JSDoc来指定参数是可选的？

根据@param的JSDoc wiki，你可以指出@param是可选的 /** @param {String} [name] */ function getPerson(name) { } 你可以使用内联参数来表示一个参数 function getPerson(/**String*/ name) { } 我可以像下面这样将它们组合起来，这很好。 /** @param [name] */ function getPerson(/**String*/name) { } 但是我想知道是否有办法在可能的情况下全部内联。

如何在jsdoc中描述“对象”参数？

// My function does X and Y. // @params {object} parameters An object containing the parameters // @params {function} callback The callback function function(parameters, callback) { } 但是，如何描述参数对象的结构？ 例如，它应该是这样的： { setting1 : 123, // (required, integer) setting2 : 'asdf' // (optional, string) }