Wie beschreibe ich „Objekt“ -Argumente in jsdoc?

Last modified: 15.05.2020
You are here:
Estimated reading time: < 1 min

Wenn erwartet wird, dass ein Parameter eine bestimmte Eigenschaft hat, können Sie dies unmittelbar nach dem @ param-Tag für diesen Parameter wie folgt dokumentieren:

 /**
  * @param userInfo Information about the user.
  * @param userInfo.name The name of the user.
  * @param userInfo.email The email of the user.
  */
 function logIn(userInfo) {
        doLogIn(userInfo.name, userInfo.email);
 }
Was this article helpful?
Dislike 0

Reader Interactions

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert