Comment analysis for program comprehension

Abstract

The constant demanding, mostly from Software Maintenance professionals, so that it could be created new and more efficient methods of understanding programs, have put several challenges to Program Comprehension researchers. Nowadays, the programmers are not satisfied with the simple extraction of the program's structure, which mainly resides on the control and dataflow identification. They want to know the meaning of the program, so they can identify the real world concepts that are materialized on the source code of the program, which would provide a better and more efficient understanding of the program. To solve this problem, Program Comprehension researchers have, mainly, developed approaches that use techniques which are based on Information Retrieval Systems, like search engines. The strategy involves the retrieval of non structured information, properly ranked, answering a question the system can interpret. Considering Program Comprehension, this strategy enables the programmers to search for real world concepts, also known as Problem Domain, implemented and mapped into programming concepts, also known as Program Domain. Although its use is not consensual, source code comments have the main objective of helping understand the source code, and it has already been proven its value on the process of comprehending, through several studies. Even though the reasons for this fact have not yet been proved, some authors have defended that source code comments are an important vehicle for the inclusion of Problem Domain information and that their exploration improves and increases the comprehension process. Therefore, the presenting Master Dissertation exposes the development of a solution based on Information Retrieval algorithms, based on Information Retrieval Systems, in order to check if, in fact, the information included in comments can contribute in a decisive way to increase the efficiency of the comprehension process of a given program or software system. The results and conclusions, extracted from this work, showed that comments, properly analyzed and classified by the developed system, helped to better understand the Problem Domain concepts and their materialization on the source code. The developed solution showed itself able of meeting the challenges posed, and proved to be a usefull and efficient tool for the comprehension tasks that may emerge on the process of software maintence of a system.

As constantes exigências, principalmente vindas dos profissionais envolvidos na manutenção de software, para que sejam encontradas novos e mais eficientes métodos para entender programas, têm posto variadíssimos desafios aos investigadores na área de Compreensão de Programas. Atualmente, os programadores não ficam satisfeitos com a simples extração da estrutura do programa, que passa pela identificação principalmente do controlo e do fluxo de dados do programa. Eles querem saber qual a semântica do programa, de maneira a poderem identificar os conceitos do mundo real que estão materializados no código fonte do programa, o que proporcionaria uma melhor e mais eficiente compreensão do programa.

Para resolver este problema, os investigadores da área de Compreensão de Programas têm, maioritariamente, criado abordagens que utilizam técnicas baseadas nos sistemas de Information Retrieval, como os motores de busca. A estratégia passa por retornar informação, não estruturada, devidamente classificada, respondida a uma pergunta que o sistema consegue interpretar. Em relação à Compreensão de Programas, esta estratégia permite aos programadores procurarem os conceitos do mundo real, também conhecido como Domínio do Problema, implementados e mapeados em conceitos da programação, também conhecido como Domínio da Programação.

Apesar da sua utilização não ser consensual, os comentários no código fonte têm o principal objetivo de ajudar a compreender o código, e já foi provado a sua utilidade no processo de compreensão através de vários estudos. Apesar de ainda não ter sido provada o porquê deste facto, alguns autores têm defendido que os comentários são um importante veículo na inclusão de informação do Domínio do Problema do programa e que a sua exploração melhora e aumenta a eficiência do processo de compreensão.

Sendo assim, a presente Dissertação de Mestrado expõe o desenvolvimento de uma solução baseado nos algoritmos de Information Retrieval, baseados nos sistemas de Information Retrieval, de maneira a tentar perceber se, de facto, a informação contida nos comentários conseguem contribuir de forma decisiva para aumentar a eficiência do processo de compreensão de um dado programa ou sistema de software.

Os resultados e conclusões retirados deste trabalho mostraram que os comentários, devidamente analisados e classificados pelo sistema desenvolvido, ajudaram a perceber devidamente os conceitos do Domínio do Problema e as suas materializações no código fonte. A solução criada mostrou-se capaz de responder aos desafios lançados, e provou ser uma ferramenta útil e eficiente para as tarefas de compreensão que possam surgir no processo de manutenção de software.