JSDoc ist eine Syntax zum Hinzufügen von Inline-API-Dokumentation zum JavaScript-Quellcode. Dies unterscheidet sich von den verschiedenen Tools, die Code analysieren und bearbeiten, der der JSDoc-Syntax folgt.
Wenn JavaScript (es205) importiert wird, scheint das Intellisense defekt zu sein.
Wenn ich in der gleichen Datei arbeite, ruft VSC die Methoden vom Objekt mit den korrekten JSDoc-Informationen automatisch ab.
Beim Importieren der Kla...
Gibt es eine Möglichkeit zu vermeiden, zwei getrennte Zeilen für @property und @param eingeben zu müssen, wenn, wie im Beispiel, im Konstruktor die Parameter und Eigenschaften identisch benannt sind.
%Vor%
Wir verwenden JsDoc, um unser Dokument der reactjs-Seiten zu erstellen. Alle kommentieren
Wir haben gemäß der jsDoc-Regel geschrieben, aber es zeigt immer noch die untenstehende Nachricht für einige Seiten:
FEHLER: D: \ Beispiel \ src...
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...
Wie würde man eine Konstante mit ngDoc dokumentieren? Ich sehe keine winkelspezifische Dokumentation zur Dokumentation von Werten, die mit .constant registriert wurden, und die jsDoc-Syntax für Konstanten scheint keine tatsächlichen Dokumente...
Ich habe eine JavaScript-Funktion, die einige Parameter einschließlich Objekttypen enthält. Eine Eigenschaft eines Parameters, die ein Objekt ist, wird jedoch als veraltet verwendet. Ich möchte diese Situation in der Dokumentation angeben, aber...
Gegeben dieser Code:
%Vor%
Wie kann ich dokumentieren, dass asyncFoo eine Promise zurückgibt, die, wenn sie erfüllt wird, eine Instanz von Bar ergibt, und wenn sie abgelehnt wird, wird eine Instanz von Error erzeugt?
%Vor%
Ich versuche meine Funktionen mit der JSDoc-Syntax zu dokumentieren.
%Vor%
Die obige Funktion akzeptiert ein einzelnes Argument, das entweder ein JQuery-Objekt oder ein von document.getElementById zurückgegebenes Element sein kann.
Wa...