Wie können Javascript-Methoden in einer 'Gruppe' in JSDOC angezeigt werden?

Question

Gibt es die Möglichkeit, Funktionen innerhalb einer Klasse zu gruppieren (AMD/RequireJS Module)? Meine Klassen haben manchmal mehr als 20 Funktionen, die eigentlich zu einer spezifischen 'Schnittstellenimplementierung' gehören und manchmal müssen sie nur zur besseren Lesbarkeit gruppiert werden.

überprüfte ich die verfügbaren jsDoc Tags aber keiner von ihnen scheinen dies zu schaffen, in Doxygen dort Anzahl von Tags sind ...

Irgendwelche Ideen?

Answer 1

dies ist ein Weg, um es, Ihre Modulform kann sehr zu tun, aber das funktioniert mit Klassen und Module:

/** 
* @module foobar 
* 
* @memberof module:foobar 
* @param {string} arg an argument 
**/ 
function one (arg) { 
    console.log(arg) 
} 
module.exports = { 
    one: one 
} 

der Schlüssel zu verwenden @memberof ist, documented here.

Sie können es mit der @ class-Dokumentation oder @module-Dokumentation verwenden, so dass es mit allen ES5-, ES6- oder TypeScript-Klassen- oder Modul-Shapes funktionieren kann, solange Sie das Containerobjekt (Klasse oder Modul) dokumentieren mit @class oder @module.

Ergebnis: