JSDoc -指定强制参数语法

JSDoc - specifying mandatory parameter syntax

本文关键字：参数 语法 -指 JSDoc      更新时间：2023-09-26

我使用@JSDoc为我的javascript库创建文档。我知道如何指示可选参数。像下面的

/*
 * @param {string} [somebody] - Somebody's name.
 */
function sayHello(somebody) {
    if (!somebody) {
        somebody = 'John Doe';
    }
    alert('Hello ' + somebody);
}

但是我想指出我的API中的一些参数是强制性的。如何使用JSDOC指示它。我没有找到任何来自JSDoc tags-param

除非将参数标记为可选，否则该参数被认为是强制性的。你不需要做任何额外的事情。要使您的somebody参数是强制性的，您只需删除括号:

@param {string} somebody - Somebody's name.
相关文章：