[英]JSDoc - specifying mandatory parameter syntax
I am using @JSDoc to create documentation for my javascript library. 我正在使用@JSDoc为我的javascript库创建文档。 I know how to indicate optional parameter. 我知道如何指示可选参数。 like below 如下
/*
* @param {string} [somebody] - Somebody's name.
*/
function sayHello(somebody) {
if (!somebody) {
somebody = 'John Doe';
}
alert('Hello ' + somebody);
}
But I would like to indicate some parameters in my API are mandatory. 但我想说明我的API中的一些参数是强制性的。 How to indicate it using JSDOC. 如何使用JSDOC表明它。 I don't find any from JSDoc tags-param 我没有从JSDoc tags-param中找到任何东西
Unless you mark a parameter as optional, then the parameter is considered mandatory. 除非将参数标记为可选,否则该参数被视为必需参数。 There's nothing additional you need to do. 你不需要做任何额外的事情。 To make your somebody
parameter mandatory you'd just remove the brackets: 要使你的somebody
参数成为必需参数,你只需删除括号:
@param {string} somebody - Somebody's name.
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.