Si j'estime qu'une partie du code pourrait être obscure ou mal comprise, je factorise et ajoute une nouvelle fonction implémentant cette partie avec un nom explicite et une description doxygen de la fonction...
Ca dépend du code en question. Sur un algo bien complexe, c'est pas en le factorisant que tu vas le rendre plus compréhensible, d'ailleurs, c'est souvent mission impossible de factoriser la chose en laissant un truc propre...
J'ai bossé y'a pas très longtemps sur l'algo de placement intelligent de Kwin pour le porter sous Compiz, ce que j'ai pu remarquer:
- Le début du code commence par un commentaire expliquant l'historique de l'algo, mais rien n'expliquant son fonctionnement...
- Des commentaires dans le code qui après étude permettent de comprendre ce qu'il se passe.
Donc, je pense que commenter une fonction et commenter son code sont deux choses qui s'entrecoupent. Si t'as l'un et pas l'autre, mais t'es un peu plus avancé mais pas trop.
Bien, sur, cela ne sert à rien de commenter du code qui se lit de par lui meme ;)
[^] # Re: commenter le code?
Posté par gnumdk (site web personnel) . En réponse au journal à quand un code commenté ?. Évalué à 7.
Ca dépend du code en question. Sur un algo bien complexe, c'est pas en le factorisant que tu vas le rendre plus compréhensible, d'ailleurs, c'est souvent mission impossible de factoriser la chose en laissant un truc propre...
J'ai bossé y'a pas très longtemps sur l'algo de placement intelligent de Kwin pour le porter sous Compiz, ce que j'ai pu remarquer:
- Le début du code commence par un commentaire expliquant l'historique de l'algo, mais rien n'expliquant son fonctionnement...
- Des commentaires dans le code qui après étude permettent de comprendre ce qu'il se passe.
Donc, je pense que commenter une fonction et commenter son code sont deux choses qui s'entrecoupent. Si t'as l'un et pas l'autre, mais t'es un peu plus avancé mais pas trop.
Bien, sur, cela ne sert à rien de commenter du code qui se lit de par lui meme ;)