Comment faire des commentaires des fonctions javascript ?

Question

Je vous écris actuellement certains client script java côté code et issu d’un milieu .net j’ai toujours/commentaire de document mes méthodes, les remarques, les arguments etc.. Alors maintenant je veux document/commenter mes fonctions javascript et je me demandais quelles sont les méthodes normalisées et les méthodes pour cela ?

Answer 1

Vous pouvez utiliser le style jsdoc qui vous permettra de générer la documentation plus tard

comme ceci

Answer 2

La norme que j’ai l’habitude d’est jsdoc : http://code.google.com/p/jsdoc-toolkit/

Il a un style similaire à javadoc si vous êtes familier avec cela.

Answer 3

Si vous avez déjà une méthode de documentation qui fonctionne pour vous, respectez-le. Si vous aimez les blocs de commentaire volumineux au début des fonctions qui expliquent tout à l’avance, génial. Si vous souhaitez insérer des commentaires ciblés sur des lignes spécifiques, coller avec qui au lieu de cela.