Documentation d'une variable ou constante
Variable et constantes à documenter
Un code source peut contenir de nombreuses variables. Écrire une description à chaque variable que nous créons serait définitivement inutile. Nous documenterons donc uniquement les variables et constantes étant directement dans une classe ou un module. Si une variable est déclaré à l'intérieur d'une fonction, on ne mettra pas de commentaire de documentation. Toutefois, une variable déclaré comme variable de classe devra être documenté.
Comme pour les classes, les commentaires de documentation des variables et constantes de classe doivent se trouver juste au dessus de celles-ci.
Exemples
Un commentaire de documentation de variable ou constante pourrait ressembler à ceci:
C#
Java
Javascript
À noter
Dans les langages non typé où les variables n'ont pas explicitement de type, comme le Javascript, il est généralement bonne pratique d'indiquer le type de la variable dans les commentaires de documentation.