C'est pour ça que j'ai arrêté les documentations qui paraphrasent le nom et le type de la variable. Ca sert juste a rien dans 95% des cas.
Je préfère documenter les pré/post conditions, les invariants et les throw.
Bref, le contrat, et ce qui est fait si le contrat n'est pas respecté.
Je pense vraiment que c'est la meilleure approche, ça m'évite de paraphraser mon code, et donc la quantité de (削除) merde (削除ここまで) commentaires diminue drastiquement, tout en fournissant des informations bien plus pertinentes (même si il est vrai qu'on les retrouve dans le code, mais c'est parfois éparpillé dans les 20-30 lignes de fonction...)
Quant aux return... bah c'est aussi rarement utile que les paramètres dans un langage qui supporte les exceptions, puisque dans ce cas on peut se permettre de ne pas s'en servir pour indique si y'a eu ratage ou pas.
Et même comme ça, je ne commente pas les fonctions triviales (genre moins de 5 lignes). Bon, après, j'ai une très nette préférence pour les langages ayant un typage fort, donc je pense que ça aide pas mal. Quand on passe un const &uint8_t, on sait déjà beaucoup de choses sur le paramètre, même sans son nom.
Et si j'ai besoin de flags, plutôt que d'utiliser un moche int, je lui mets au moins un typedef, et en général je suis plutôt du genre à vouloir utiliser des bitfield. Plutôt que d'utiliser des #define dont on ne sait jamais trop où, quand et comment ils sont définis, et ne seront jamais vérifiés par le compilo.
[^] # Re: La bonne question serait plutôt : Que commentez-vous ?
Posté par freem . En réponse au sondage Les commentaires et vous ?. Évalué à 2.
C'est pour ça que j'ai arrêté les documentations qui paraphrasent le nom et le type de la variable. Ca sert juste a rien dans 95% des cas.
Je préfère documenter les pré/post conditions, les invariants et les throw.
Bref, le contrat, et ce qui est fait si le contrat n'est pas respecté.
Je pense vraiment que c'est la meilleure approche, ça m'évite de paraphraser mon code, et donc la quantité de
(削除) merde (削除ここまで)commentaires diminue drastiquement, tout en fournissant des informations bien plus pertinentes (même si il est vrai qu'on les retrouve dans le code, mais c'est parfois éparpillé dans les 20-30 lignes de fonction...)Quant aux return... bah c'est aussi rarement utile que les paramètres dans un langage qui supporte les exceptions, puisque dans ce cas on peut se permettre de ne pas s'en servir pour indique si y'a eu ratage ou pas.
Et même comme ça, je ne commente pas les fonctions triviales (genre moins de 5 lignes). Bon, après, j'ai une très nette préférence pour les langages ayant un typage fort, donc je pense que ça aide pas mal. Quand on passe un const &uint8_t, on sait déjà beaucoup de choses sur le paramètre, même sans son nom.
Et si j'ai besoin de flags, plutôt que d'utiliser un moche int, je lui mets au moins un typedef, et en général je suis plutôt du genre à vouloir utiliser des bitfield. Plutôt que d'utiliser des #define dont on ne sait jamais trop où, quand et comment ils sont définis, et ne seront jamais vérifiés par le compilo.