So dokumentieren Sie eine von einer Funktion zurückgegebene Funktion mit JSDoc

Question

Ich verwende JSDoc für die Parameterdokumentation.

Es ist klar, wie die Parametertypen für many_prompts dokumentiert werden, aber was ist der richtige Weg, um die zurückgegebene Funktion zu dokumentieren?

/** 
* @param {Number} - number of times to prompt 
* @return {Function(prompt{Number})} - the returned function 
*/ 
function many_prompts(count) { 
    return function(prompt) { 
    for(var i=0; i < count; i++) alert(prompt); 
    } 
} 


//Example of use: 
var y =many_prompts(3); 
y('Hello World'); 

Answer 1

können Sie die innere Funktion dokumentieren und dann wie verweisen, so

/** 
* @param {Number} - number of times to prompt 
* @return {many_prompts~inner} - the returned function 
*/ 
function many_prompts(count){ 
    /** 
    * My inner function 
    * 
    * @param {object} prompt Some parameter 
    */ 
    var inner = function(prompt){ 
    for(var i=0;i<count;i++) alert(prompt} 
    }; 
    return inner; 
}