JSDoc
- ¿Cual es la sintáxis de los comentarios de documentación en JSDoc? ¿Como empiezan?
- ¿Donde debo ubicar un comentario de documentación JSDoc para documentar un cierto código?
Special JSDoc tags can be used to give more information. For example,
- If the function is a constructor for a class, you can indicate this by adding a __ tag (fill the gap)
- ¿Cómo se documenta un parámetro de una función?
¿Que hace esta documentación JSDoc?
/** * See {@tutorial gettingstarted} */ function myFunction() {}
¿Que hace esta documentación JSDoc?
/** * See {@link MyClass} and [MyClass's foo property]{@link MyClass#foo}. * Also, check out {@link http://www.google.com|Google} and * {@link https://github.com GitHub}. */ function myFunction() {}