A Metric for Software Readability

✒ Enzo SandrĂ© · 📆 19/02/2024 · #ïžâƒŁ Façonnage de code · đŸ—Łïž Nommage

đŸ§¶ La lisibilitĂ© d’un code est-elle universelle ? Autrement dit, classerions-nous tous de maniĂšre identique une sĂ©rie de snippets du plus lisible au plus obscur ? Deux amĂ©ricains ont tentĂ© l’expĂ©rience et semblent montrer qu’une corrĂ©lation modĂ©rĂ©e existe.

✂ Les chercheurs ont ensuite recherchĂ© les caractĂ©ristiques faisant un code lisible. La taille des identifiants n’a aucune corrĂ©lation avec la lisibilitĂ©. allonger ceux-ci sans but prĂ©cis n’apporte rien Ă  la comprĂ©hension. Les commentaires sont faiblement corrĂ©lĂ©s Ă  la lisibilitĂ©, probablement car ceux-ci tendent Ă  documenter un code peu lisible. La principale mĂ©trique corrĂ©lĂ©e Ă  la lisibilitĂ© semble ĂȘtre le nombre d’instructions par ligne. La quantitĂ© de lignes vides arrive peu aprĂšs.

đŸŽ¶ AĂ©rer son code semble ĂȘtre le meilleur conseil pour le rendre plus lisible. Comme dans un beau poĂšme, l’aĂ©ration et le placement des mots a un sens.

SOURCE

Buse, Raymond P. L. and Westley Weimer. “A metric for software readability.” International Symposium on Software Testing and Analysis (2008). DOI: 10.1145/1390630.1390647

Enzo Sandré


📄 Lien public DOIs: 10.1145/1390630.1390647