Wie wird die Dokumentation einer JavaScript-Funktion standardmäßig hinzugefügt?

Question

Ich versuche, API-Dokumente für ein JavaScript-Projekt zu erstellen. Verfügt JavaScript über etwas Ähnliches wie Python's docstring?

function add(a, b) {
  /**
    Returns the sum of `a` and `b`.
  */
  return (a - 0) + (b - 0);
}

Answer 1

JSDoc ist eine Möglichkeit, dies zu tun.

/**
 * Adds two numbers.
 */
function add(a, b) {
    return a+b;
}

Answer 2

Haben Sie gesehen JSDoc (inzwischen ersetzt durch JSDoc-Werkzeugsatz )?

Answer 3

Als ich es brauchte, war JSDoc das einzige verfügbare Tool, und das war ziemlich unübersichtlich. Es kam immer zu Stapelüberläufen, weil Perl und reguläre Ausdrücke zum Parsen des Quellcodes verwendet wurden. Auf den ersten Blick JSDoc-Werkzeugsatz wie erwähnt gut aussehen, verwenden sie jetzt JavaScript.

Answer 4

PDoc ist ein Inline-Dokumentationsgenerator für die Prototyp Bibliothek, geschrieben in Ruby.