Zhen Ming Jiang
ABSTRACT
It is common, especially in large software systems, for developers to change code without updating its associated comments due to their unfamiliarity with the code or due to time constraints. This is a potential problem since outdated comments may confuse or mislead developers who perform future development. Using data recovered from CVS, we study the evolution of code comments in the PostgreSQL project. Our study reveals that over time the percentage of commented functions remains constant except for early fluctuation due to the commenting style of a particular active developer.
- R. Fjeldstad and W. Hamlen. Application program maintenance-report to our respondents. In Tutorial On Software Maintenance, pages 13--27.1983.Google Scholar
- A. E. Hassan and R. C. Holt. C-REX: An Evolutionary Code Extractor for C. May 2004.Google Scholar
- D. Parnas. Software aging. In Proceedings of the 16th International Conference on Software Engineering, pages 279--287, Sorrento, Italy, May 1994. Google ScholarDigital Library
- D. E. Perry and W. M. Evangelist. An Empirical Study of Software Interface Faults--An Update. In Proceedings of the 20th Annual Hawaii International Conference on Systems Sciences, pages 113--136, Hawaii, USA, Jan. 1987.Google Scholar
Index Terms
- Examining the evolution of code comments in PostgreSQL
Recommendations
Is there a correlation between code comments and issues?: an exploratory study
SAC '20: Proceedings of the 35th Annual ACM Symposium on Applied ComputingComments in a software code base are one of the key artifacts that help developers in understanding the code with respect to development and maintenance. Comments provide us with the information that is used as a software metric to assess the code ...
A Survey on Research of Code Comment
ICMSS 2019: Proceedings of the 2019 3rd International Conference on Management Engineering, Software Engineering and Service SciencesCode comments are one of the effective means for assisting programmers to understand the source code. High-quality code comments play an important role in areas such as software maintenance and software reuse. Good code comments can help programmers ...
Analyzing the co-evolution of comments and source code
Source code comments are a valuable instrument to preserve design decisions and to communicate the intent of the code to programmers and maintainers. Nevertheless, commenting source code and keeping comments up-to-date is often neglected for reasons of ...
Comments