les avantages et les inconvénients des commentaires multilignes et des commentaires d'une ligne

Question

De nombreux langages contemporains autorisent deux types de commentaires: l'un dans lequel les délimiteurs sont utilisés aux deux extrémités (commentaires sur plusieurs lignes) et l'autre dans lequel un délimiteur ne marque que le début des commentaires (commentaires d'une ligne). Discutez des avantages et des inconvénients de chacun en ce qui concerne les critères (lisibilité, écriture, fiabilité, coût).

Answer 1

Il n'y a pas de bonne réponse ici, ils diffèrent d'une manière personnelle ou par style de codage.

Avec les deux vous avez un commentaire facile à écrire/lire. Le commentaire peut être aussi long que vous le souhaitez, mais généralement les commentaires courts et précis sont meilleurs, sinon vous ne réécrire le code que comme commentaire.

//assings 10 to x will make everything happier // the code won't change (further reading) 
x = 10 
if (x == 10) 
    happy++ 

Comment ce commentaire a aidé les futurs utilisateurs?

Avec plusieurs lignes, cependant, vous pouvez écrire un peu de texte, mais lire ce serait un peu plus de travail si vous deviez encore lire (et comprendre) le code. Cela ne changera pas la façon dont les programmeurs les liront, mais ils vous aideront quand vous avez plus d'une ligne de commentaire (comme les URL de référence) et que vous ne voulez pas démarrer chaque ligne avec un balisage de commentaire.

Moi, personnellement, comme le code multiligne pour une raison simple: il agroups parties logiques ensemble

//*assings 10 to x will make everything happier //the code is on 
x = 10 
if (x == 10) 
    happy++ 
//*/ 

Maintenant, je peux facilement tourner le code Situés entre ces commentaires et hors cette partie du code (pour les tests, par exemple) seulement en changeant le premier "/". Ce serait un avantage de multiline.

/*assings 10 to x will make everything happier // the code is off 
x = 10 
if (x == 10) 
    happy++ 
//*/