Wie dokumentieren Sie anonyme Funktionen? [geschlossen]

Question

Ich beziehe mich speziell auf JavaScript anonyme Funktion, aber diese zu anderen Sprachen relevant sein könnten. Ich mag JSDoc Notationen in meine Skripte verwenden, weil ich andere Leute wissen, wird es früher oder später werden Hacking. Wenn ich habe ziemlich komplexe anonyme Funktion wie dokumentieren die Leute es so, dass es von Eclipse und anderen IDE aufgenommen wird, die JSDoc oder JavaDoc Notationen verstehen?

/**
 * Blah Blah blah
 *
 * @param Object Blah blah blah
 * @return Blah Blah Blah
 * @type Object
 */
function foo(this) {
......
this.bar = function () { ... complex code .....};
......
return obj;
}

Danke

Answer 1

Im Idealfall sollte eine anonyme Funktion kurz sein und eine einfache Aufgabe. Also ... die äußere Funktion, die enthält, sollte es ausreichende Dokumentation zur Verfügung stellen.

Wenn das nicht der Fall ist, sollten Sie wahrscheinlich die anonyme Funktion extrahieren in eine benannte Funktion, und dann richtig dokumentieren.

Answer 2

Das ist nicht wirklich eine anonyme Funktion. Es hat einen Namen. Der Name ist "bar", oder, genauer gesagt, "foo.bar". Was das wirklich ist, zu denken, meinen Weg, ist ein Funktionsliteral. Zu meiner Denkweise, ist eine wirklich anonyme Funktion eine Funktion, die wirklich keinen Namen hat, wie ein Argument an einem anderen Funktion:

var intervalId = setTimeout(function() { // statements }, 1000);

Jetzt, nach David Flanagan in Javascript: "mit der Funktion () erstellt" The Definitive Guide , eine anonyme Funktion ist eine, die ist Er sichert seine Wetten gibt, aber, weil er weiter zum Zustand übergeht, dass solche Funktionen werden nur „manchmal“ anonym genannt.

Warum bin Anhebung ich dieses Problem hier? Weil ich denke, wenn Sie einen Namen für etwas haben, kann es nicht wirklich anonym aufgerufen werden. Und ich denke, der Begriff „anonymous“ in Bezug auf Javascript-Funktionen bestenfalls mehrdeutig ist, und soll zumindest von jemandem irgendwo geklärt werden.

Answer 3

Durch sie nicht anonym zu machen.

Ich finde, der beste Weg, um etwas zu Dokument nicht ist. Was ich damit meine ich, dass ich Gebrauch gut Variable / Funktionsnamen und freier Code als mein Dokument.

So in diesem Fall würde ich erstellen Sie einfach eine statische Funktion, die erzeugt, dass anonyme und somit kann ich die statische Funktion eine gute geben name.it