JSDoc erbt Parameterdokumentation

8

Nehmen wir an, ich habe zwei Funktionen, wobei die eine die andere erweitert.

%Vor%

Diese zwei Funktionen sind in zwei separaten Dateien. Gibt es eine Möglichkeit, die Parameterdokumentation von der Funktion Base in meiner Funktion Foo zu übernehmen, oder muss ich die Dokumentation zweimal schreiben?

Ich habe versucht, settings a @typedef folgendermaßen aussehen zu lassen:

%Vor%

Dies bezieht sich jedoch nur auf globale Typdefinitionen, und ich möchte, dass der Parameter auf derselben Seite wie die Funktion dokumentiert wird. Aber ist das überhaupt möglich, ohne die Dokumentation zweimal zu schreiben?

    
LongInt 08.04.2015, 17:30
quelle

2 Antworten

2

Ich denke nicht, dass das gemacht werden kann. Sie können es über @typedef wie in Ihrer Frage dokumentieren, aber es verbindet nur den Typ mit seiner Definition. Ich bin mir nicht bewusst, wie ein definierter Typ eingebunden werden kann.

    
SGD 10.04.2015, 08:53
quelle
0

Es gibt eine Möglichkeit, eine Unterklasse inline zu definieren, aber ich denke nicht, dass es in diesem speziellen Fall hilft. Wie auch immer, vielleicht hilft es anderen:

%Vor%

Dies sollte eigentlich in jedem Objekt-Literal-Szenario funktionieren. Wir verwenden es in Verbindung mit einem Framework für die Vererbung funktionaler Objekte (Legacy Dojo 1.10 declare), das Sie mit einem Objektliteral innerhalb eines Funktionsaufrufs ableiten

Auf diese Weise können wir die Vererbung richtig dokumentieren.

    
Flowkap 03.11.2017 10:19
quelle

Tags und Links