Version imprimable
Bonjour,
Je ne suis pas sur que ce post soit à sa bonne place, ou que la question n'est pas déjà fait l'objet d'un post.
Je cherche des conseils pour bien commenter un code, ainsi que des exemples de références de code bien commenté.
Et éventuellement un retour sur votre expérience en la matière.
Bonjour, le but des commentaires est bien sûr la maintenance du code, donc avant de faire des commentaires, je dirai que le premier pas est de choisir des noms de variables pertinents (éviter liste1, jbutton5, ...)
Ensuite, le minimum syndicale est de faire la javadoc de chaque méthode et attribut, en expliquant ce que fait la méthode et à quoi correspond l'attribut. (sans oublier le retour, en précisant si il peut être null ou pas, donner les plages de valeurs acceptées des paramètres)
Il existe des outils qui permettent de vérifier automatiquement que la javadoc est rédigée pour chaque classe d'un projet, très pratique pour que tout le monde respecte la norme. (checkstyle par exemple)
Après tu peux aussi commenter à l'intérieur des méthodes, par exemple certaines boucles. ("Pour chaque machin, on récupère telle information", "Tant que...")
Je n'ai pas d'exemple à te donner, je ne travaille pas dans le monde libre.
Bonjour,
Merci pour ces conseils. Pour préciser, je viens de récupérer le code d'un développeur sans aucun commentaire.
Les sources sont de type jsp/classes java / Servlet
Je connaissais la javadoc pour la partie classes/servlet, mais est ce aussi possible sur des jsp ?
Merci