Chaque fois que j'écris une construction if-else-typique dans n'importe quelle langue, je me demande quelle serait la meilleure façon (en termes de lisibilité et de vue d'ensemble) d'y ajouter des commentaires. Surtout lorsque je commente la clause else, les commentaires me semblent toujours hors de propos. Disons que nous avons une construction comme celle-ci (les exemples sont écrits en PHP):
if ($big == true) {
bigMagic();
} else {
smallMagic()
}
Je pourrais le commenter comme ceci:
// check, what kind of magic should happen
if ($big == true) {
// do some big magic stuff
bigMagic();
} else {
// small magic is enough
smallMagic()
}
ou
// check, what kind of magic should happen
// do some big magic stuff
if ($big == true) {
bigMagic();
}
// small magic is enough
else {
smallMagic()
}
ou
// check, what kind of magic should happen
// if: do some big magic stuff
// else: small magic is enough
if ($big == true) {
bigMagic();
} else {
smallMagic()
}
Quels sont vos exemples de bonnes pratiques pour commenter cela?
else { // for future reader: sorry, at the moment of writing this I did not have time and skills to come up with a better way to express my logic