2016-08-23 89 views
3

我正在使用@JSDoc爲我的JavaScript庫創建文檔。我知道如何表示可選參數。像下面一樣JSDoc - 指定必需的參數語法

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

但我想指出我的API中的一些參數是強制性的。如何使用JSDOC指示它。 我沒有找到任何來自 JSDoc tags-param

回答

2

除非您將參數標記爲可選參數,否則該參數被視爲強制參數。沒有什麼額外的你需要做的。爲了使您的somebody參數強制你只是刪除括號:

@param {string} somebody - Somebody's name.