web-dev-qa-db-fra.com

Existe-t-il une convention sur la façon de documenter un fichier JavaScript avec des commentaires? Comme les signatures de fonction, les exemples, etc.

Java a Javadoc, Python a docstring. Y a-t-il quelque chose de similaire en JavaScript?

47
Lyd

Le plus couramment utilisé est JsDoc ( https://jsdoc.app/ ).

C'est également un outil qui génère de la documentation à partir de vos sources, commentée avec le style JsDoc: https://github.com/jsdoc3/jsdoc

42
Tibos