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:
1 2 3 4 5 6 7 8 | <span class="com">/** * @param userInfo Information about the user. * @param userInfo.name The name of the user. * @param userInfo.email The email of the user. */</span> <span class="kwd">function</span><span class="pln"> logIn</span><span class="pun">(</span><span class="pln">userInfo</span><span class="pun">)</span> <span class="pun">{</span><span class="pln"> doLogIn</span><span class="pun">(</span><span class="pln">userInfo</span><span class="pun">.</span><span class="pln">name</span><span class="pun">,</span><span class="pln"> userInfo</span><span class="pun">.</span><span class="pln">email</span><span class="pun">);</span> <span class="pun">}</span> |
Schreibe einen Kommentar