Quels sont les meilleurs commentaires que vous avez déjà rencontrés dans un code source ?
Samedi 02 août 2014 à 12:00
Cette discussion est en relation avec le billet suivant :
Quels sont les meilleurs commentaires que vous avez déjà rencontrés dans un code source ?
/// <summary>
/// Gets or sets the first name
/// </summary>
public string FirstName { get; set; }
/// <summary>
/// Does the stuff
/// </summary>
public void DoStuff() { ... }
Et aucun autre commentaire au milieu du code. // Problem with framework, this sucks but is mandatory
public bool EstTerminé()
public bool IsFinished()
x = obtenirFlux().getStreamContent()
) et surtout parce que peu de langage autorise autre chose que de l'ascii pour le nommage (Python 3 autorise UTF-8 !), et donc on se retrouve avec "estTermine" au lieu de "estTerminé" pour reprendre ton exemple, ce qui n'est pas pareil PetitCalgonNote que VisualStudio s'en fout de l'encoding des caractères et que tu peux théoriquement avoir des variables, des fonctions, des interfaces avec des lettres accentuées sans problème de manière officielle.Ca dépend du langage, et à ma connaissance, ils sont bien peu nombreux à proposer ça en standard... Après, c'est sûr, si ta boîte a envie, elle peut simplement modifier la grammaire du langage et enjoy.
PetitCalgonAvec l'intellisense, tu t'en fous, c'est complété automatiquement quand tu as trouvé la fonction que tu veux, quelque soit les lettres accentuéesOui mais non. Tu ne peux pas te reposer sur un outil pour justifier d'utiliser une langue qui, en dehors de ça, pose des soucis Par ailleurs, c'est dangereux, car tu peux alors mélanger des
estTermine
avec des estTerminé
, etc. ce qui peut rendre le code encore plus difficile à lire/comprendre (et je suis sûr qu'on peut facilement trouver un exemple legit de mots français, traductions d'un terme usuel dans un code anglais, qui est ambigu et pourtant "nécessaire" dans le code).1996-2024 — Lexpage v4 — GPLv3 (sources)
page générée le 14 novembre 2024 à 18:26:50