C'est pour cela que personnellement j'écris généralement le commentaire avant le code. Non seulement, ça m'aide à avoir une bonne vue de ce que je vais faire (et ça fait gagner du temps, après l'écriture du code n'est limitée pratiquement que par la vitesse de frappe), mais aussi ça aide à être pertinent sur les commentaires. Si le problème est vraiment épineux, c'est souvent une mise en mots de ce que j'ai écrit/gribouillé sur ma feuille de papier pour résoudre le problème.
Après l'écriture de la méthode ou fonction, j'ajuste en ajoutant ce qui pourrait manquer, ou en enlevant ce qui est manifestement en trop.
Cela me paraît une bonne façon de faire, confirmée par la grande majorité des développeurs expérimentés et bons que je connais, quel que soit le langage ou les techniques utilisées.
Après un code plus "technique" n'est pas commenté exactement de la même manière qu'un code plus "fonctionnel" mais le principe reste le même.
[^] # Re: Commenter l'intention
Posté par Flo . En réponse au journal To comment or not to comment. That is the question.. Évalué à 1.
C'est pour cela que personnellement j'écris généralement le commentaire avant le code. Non seulement, ça m'aide à avoir une bonne vue de ce que je vais faire (et ça fait gagner du temps, après l'écriture du code n'est limitée pratiquement que par la vitesse de frappe), mais aussi ça aide à être pertinent sur les commentaires. Si le problème est vraiment épineux, c'est souvent une mise en mots de ce que j'ai écrit/gribouillé sur ma feuille de papier pour résoudre le problème.
Après l'écriture de la méthode ou fonction, j'ajuste en ajoutant ce qui pourrait manquer, ou en enlevant ce qui est manifestement en trop.
Cela me paraît une bonne façon de faire, confirmée par la grande majorité des développeurs expérimentés et bons que je connais, quel que soit le langage ou les techniques utilisées.
Après un code plus "technique" n'est pas commenté exactement de la même manière qu'un code plus "fonctionnel" mais le principe reste le même.