Introduction
Écrire des classes, c'est bien, on sait maintenant déjà faire pas mal de ce côté-là. Une meilleure chose est d'ajouter des commentaires au code afin de le rendre plus clair pour soi-même et pour les autres. Ces commentaires sont en langue naturelle et choisis par le programmeur.
Il existe d'autres commentaires spéciaux, débutant par le symbole /** et terminant par */. Ceux-ci sont des commentaires structurés, liés à des entités spécifiques (classes, méthodes, ...) et grâce auxquels il sera possible de générer de la documentation comme celle de la documentation de l'API Java avec laquelle nous sommes maintenant familiers.
La première partie du chapitre traite de ces commentaires et de la syntaxe à utiliser pour les écrire correctement. La deuxième partie du chapitre traite une autre manière de documenter du code basée sur les spécifications et la programmation par contrat.
Plan du chapitre
Chapitre 7