13
Ich verwende JSDoc für die Parameterdokumentation.So dokumentieren Sie eine von einer Funktion zurückgegebene Funktion mit JSDoc
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');
Gibt es eine Möglichkeit, dies für anonyme innere Funktionen zu tun? –
Für JSDoc benötigen Sie eine Art von Referenz, ich denke, es hängt davon ab, wie die anonyme Funktion verwendet wird. Hast du ein Beispiel? – SGD
Wird das offiziell irgendwo dokumentiert? Kann es nicht finden. –