Um estudo sobre definição e avaliação da readability e legibility do código fonte

Abstract

Entender código fonte é uma atividade importante no desenvolvimento de software. Ela é fundamental durante a correção de problemas, evolução do sistema e durante otimização de código. Código que é difícil de entender pode impactar negativamente essas e outras atividades. A legibilidade do código é um dos fatores que pode estar ligado ao problema de compreensão do código. Muitos estudos em engenharia de software avaliam a legibilidade de diferentes aspectos da linguagem e práticas de programação. Esses estudos fazem suas avaliações de legibilidade através de diferentes características, por exemplo, tempo para completar uma tarefa, número de erros cometidos ou opinião do sujeito. Frequentemente, esses trabalhos utilizam vários termos para discutir sobre os elementos que tornam um trecho de código mais ou menos legível e fácil de compreender. Os termos readability e legibility são frequentemente utilizados como sinônimos. No entanto, esses dois termos devem ter significados claros, distintos, embora relacionados, assim como são definidos nas áreas de educação, linguística e design, onde representam aspectos diferentes do texto ou do ambiente. Assim, esse trabalho tem como objetivo estudar de forma ampla o conceito de legibilidade de código e como ele vem sendo estudado na área de Engenharia de Software. Para atingir esse objetivo, realizamos um levantamento bibliográfico sobre a temática em várias áreas do conhecimento e uma revisão sistemática da literatura na área de Engenharia de Software, onde encontramos 54 artigos relevantes para nosso estudo. Nossos resultados revelam que os conceitos de readability e legibility são bem definidos em áreas como Design e Linguística, mas na área de Engenharia de Software há termos diferentes que são sinônimos e o mesmo termo sendo usado de forma inconsistente em diferentes contextos. São encontrados na literatura vários estudos empíricos que avaliam o que torna o código mais legível. Entretanto, cada um apresenta um método diferente para medir a legibilidade do código. A maioria dos estudos incluídos na revisão sistemática avalia a readability e a legibility do código medindo a correção dos resultados dos sujeitos (83,3%) ou simplesmente pedindo suas opiniões pessoais (55,6%). Alguns estudos (16,7%) dependem exclusivamente desta última variável de resposta. Além disso, ainda existem relativamente poucos estudos que monitoram os sinais físicos do desenvolvedor, como as regiões de ativação cerebral (5%). Esses resultados não só contribuem com o conhecimento existente sobre o assunto como também deixam claro que abordagens de avaliação de compreensão de código diferentes requerem competências diferentes dos sujeitos do estudo, por exemplo, rastrear o programa versus resumir seu objetivo versus memorizar seu texto.