Using evolutionary annotations from change logs to enhance program comprehension

Evolutionary annotations are descriptions of how source code evolves over time. Typical source comments, given their static nature, are usually inadequate for describing how a program has evolved over time; instead, source code comments are typically a description of what a program currently does. We propose the use of evolutionary annotations as a way of describing the rationale behind changes applied to a given program (for example ”These lines were added to ...”). Evolutionary annotations can assist a software developer in the understanding of how a given portion of source code works by showing him how the source has evolved into its current form. In this paper we describe a method to automatically create evolutionary annotations from change logs, defect tracking systems and mailing lists. We describe the design of a prototype for Eclipse that can filter and present these annotations alongside their corresponding source code and in workbench views. We use Apache as a test case...

• Type: Conference
• Year: 2006
• Where: MSR
• Authors: Daniel M. Germán, Peter C. Rigby, Margaret-Anne D. Storey
• Keywords: Evolutionary Annotations, MSR 2006, Source Code, Source Code Comments