2016-09-19 4 views
0

In jsdoc @param,JSDOC Datentyp in @param

We can write like: 
    /** 
    * @param {Object} somebody- The employee who is responsible. 
    */ 
    function sayHello(somebody: ABC) { 
     alert('Hello ' + somebody); 
    } 

Wenn ich eine Klasse wie ABC und jemand habe, ist ein Objekt vom Typ ABC, kann ich es so schreiben ,?

Das heißt, kann ich meinen eigenen Objekttyp in geschweiften Klammern von Param statt als Objekt geben? Vielen Dank im Voraus ...

Antwort

1

Wenn Sie Ihren Code betrachten, verwenden Sie wahrscheinlich TypeScript. Sie haben 2 Möglichkeiten:

  • Wenn ABC ein Objekt oder eine Klasse ist, dass Sie es durch die Verwendung eines JSDoc Namen verweisen können (zB: myNamespaceOrModule.ABC};
  • Wenn ABC kein eigentliches JavaScript-Objekt ist (ex: a Typoskript-Schnittstelle) als können Sie JSDoc @typedef Tag verwenden einen benutzerdefinierten Tag zu dokumentieren.

Bitte, den Code zur Verfügung stellen, wo die ABC-Klasse für eine bessere Antwort definiert ist.