#1 Le 19/04/2007, à 00:29
- potionmagique
[Java]Comment bien commenté son code ?
Salut,
est-ce que quelqu'un pourrait m'indiquer ce qu'il faut mettre pour bien commenter son code en java.
Si quelqu'un pouvait me montrer un exemple de code bien commenté, ça serait sympa.
Et pour générer la doc vers un répertoire donné.
Merci
#2 Le 19/04/2007, à 11:05
- kaworu
Re : [Java]Comment bien commenté son code ?
Salut !
Pour la doc en Java, on utilise généralement Javadoc.
je te laisse voir ici comme point de départ :
http://fr.wikipedia.org/wiki/Javadoc
"There are in order of increasing severity: lies, damn lies, statistics, and computer benchmarks."
Hors ligne
#3 Le 19/04/2007, à 12:18
- Watchwolf
Re : [Java]Comment bien commenté son code ?
voila c'est le plus simple.
Tu choisit un generateur de documentation (javadoc pour java, docygen pour le C). Et tu suit la syntaxe du generateur.
Hors ligne
#4 Le 20/04/2007, à 01:33
- gene69
Re : [Java]Comment bien commenté son code ?
par contre dans ce que tu racontes dans tes commentaires il faut se mettre d'accord avec soit même / avec l'équipe.
sur le dernier projet que j'ai fait la doc dyoxygen était répartie en gros dans le point h pour expliquer à quoi sert une méthode.
Dans le code .c on avait les commentaires relatifs aux modifs et aux pieges à cons dans le code.
En java tu n'as pas tant besoin de faire des fichiers d'entête... c'est plus simple.
On avait une autre règle qui dit qu'un commentaire s'applique à un bloc lorqu'il s'agit d'expliquer la sémantique du code. parfois on a créé des {} "inutile" mais ça coute rien.
Quand le berger est lâche, le loup chie de la laine.
A (draft) guide to UFO Alien-Invasion
Hors ligne