JSDoc Toolkit - So geben Sie @param und @property in derselben Zeile an

8

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%     
justtryingtomakealiving 25.06.2011, 07:19
quelle

1 Antwort

3

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 Point.x = x ist jedem Schulkind klar.

    
Microfed 06.11.2011 18:22
quelle