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.
Les cas où on a forcément le code sous les yeux sont quand même rare et c'est quand même plus pratique d'avoir la documentation affichée au survol de la souris ou avec l'autocomplétion que de devoir changer de fichier ou naviguer 200 lignes plus haut pour retrouver la fonction.
getTitle et return the title ça veut quand même vraiment dire la même chose
Oui, mais l'ide ne va pas forcément présenter la même info dans une bulle d'aide, c'est un peu redondant mais plus utilisable à mon avis.
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
Entièrement d'accord, seulement, s'il y a de la doc et que ce n'est pas écrit, je vais plutôt supposer que le développeur a réfléchi 2 secondes et qu'il l'aurait écrit s'il y en avait. Tandis que s'il n'y a pas de doc, je ne sais pas s'il y en a un et que ce n'est pas indiqué par flemme ou si c'est le comportement normal.
« Rappelez-vous toujours que si la Gestapo avait les moyens de vous faire parler, les politiciens ont, eux, les moyens de vous faire taire. » Coluche
[^] # Re: La doc est toujours utile
Posté par claudex . En réponse au journal De tout, de rien, des liens, bla bla bla. Évalué à 5.
Les cas où on a forcément le code sous les yeux sont quand même rare et c'est quand même plus pratique d'avoir la documentation affichée au survol de la souris ou avec l'autocomplétion que de devoir changer de fichier ou naviguer 200 lignes plus haut pour retrouver la fonction.
Oui, mais l'ide ne va pas forcément présenter la même info dans une bulle d'aide, c'est un peu redondant mais plus utilisable à mon avis.
Entièrement d'accord, seulement, s'il y a de la doc et que ce n'est pas écrit, je vais plutôt supposer que le développeur a réfléchi 2 secondes et qu'il l'aurait écrit s'il y en avait. Tandis que s'il n'y a pas de doc, je ne sais pas s'il y en a un et que ce n'est pas indiqué par flemme ou si c'est le comportement normal.
« Rappelez-vous toujours que si la Gestapo avait les moyens de vous faire parler, les politiciens ont, eux, les moyens de vous faire taire. » Coluche