Evidemment la documentation d'une API (où on ne voit pas forcément le code) doit être plus importante et n'a pas la même utilité qu'une documentation où on a forcément le code sous les yeux.
En l'occurrence l'exemple présenté est tout de même un peu ridicule :
getTitle et return the title ça veut quand même vraiment dire la même chose
pour l'effet de bord, je le dirais dans l'autre sens. Par défaut un get ne doit pas en avoir, et il faut documenter sa présence
[^] # Re: La doc est toujours utile
Posté par CrEv (site web personnel) . En réponse au journal De tout, de rien, des liens, bla bla bla. Évalué à 2.
Evidemment la documentation d'une API (où on ne voit pas forcément le code) doit être plus importante et n'a pas la même utilité qu'une documentation où on a forcément le code sous les yeux.
En l'occurrence l'exemple présenté est tout de même un peu ridicule :