search

JCERTIFLab / jcertif-backend-2013

JCertif Back End 2013
0 stars 4 forks source link

[Maintenabilite] Diminuer la proportion de code non documenter #113

Closed martialsomda closed 11 years ago

martialsomda commented 11 years ago

Sonar affiche 8,3% de code documenté :-) => Diminuer la proportion de code non documenter

roddet commented 11 years ago

Il parait que quand c'est bien écrit, il n'y a pas besoin de commentaires :)

martialsomda commented 11 years ago

Effectivement...Ne commenter que le code ayant besoin d'être commenté (éviter de commenter les getter/setters :-) ) . Sans même aller jusque là pour moi ça peut être bien codé mais dans la doc il y a aussi des liens vers d'autres classes @see, {@link} qui permettent de comprendre rapidement le design utilisé sans avoir forcément à mettre le nez dans l'algorithmie.

On peut néanmoins poser la question au groupe, au pire on saute dans sonar les erreurs sur la javadoc