___ tag123javascript ___ JavaScript (nicht zu verwechseln mit Java) ist eine dynamische Sprache mit mehreren Paradigmen auf hoher Ebene, die sowohl für das clientseitige als auch für das serverseitige Scripting verwendet wird. Verwenden Sie dieses Tag für Fragen zu ECMAScript und seinen verschiedenen Dialekten / Implementierungen (außer ActionScript und Google-Apps-Script).
___ tag123Dokumentationsgenerierung ___ Ein Dokumentationsgenerator ist ein Programmiertool, das Dokumentation für Programmierer (API-Dokumentation) oder Endbenutzer (Endbenutzerhandbuch) oder beides aus einer Reihe von speziell kommentierten Quellcodedateien und in einigen Fällen Binärdateien generiert .
___ tag123jsdoc ___ 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.
___ qstntxt ___
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%
___ answer8029280 ___
Sie nicht. Es ist unmöglich, weil die Argumente der Funktion und Eigenschaften eines Objekts - das sind verschiedene Variablen, sie können nicht sowohl Funktionsparameter und Objekteigenschaften sein.
Darüber hinaus würde eine solche Dokumentation den Entwickler nur verwirren, hilft aber nicht beim Verständnis der API.
Ich würde Ihnen raten, die @properties in dieser Dokumentation nicht zu verwenden, sondern @ type:
%Vor%
Aber in der Tat ist solch detaillierte Dokumentation nutzlos. Was wir im Code sprechen %code% ist jedem Schulkind klar.
___ qstnhdr ___ JSDoc Toolkit - So geben Sie @param und @property in derselben Zeile an
___ tag123documentation ___ DIESER TAG IST NUR FÜR DOKUMENTGENERATOREN. Fügen Sie auch Sprache und / oder SDE-Tag hinzu. Verwenden Sie KEINE VERBINDUNGEN, um Links zu Dokumentationen oder Tools anzufordern oder die Herstellerdokumentation zu kritisieren.
___