An exploration of how comments are used for marking related code fragments

ABSTRACT

A software developer performing a change task to a system very often has to examine a concern that is scattered across the source code of the system. Although many mechanisms attempt to alleviate the problem of dealing with scattered code, many software developers are still using more ad-hoc approaches to mark related code. In this paper, we explore how developers use comments to mark related code. We found that developers use two basic kinds of conventions to mark related code in comments: by explicitly stating relationships in the comment and by using similar comments in related code elements. These conventions have several major issues. However, we observe that using comments to mark related code fragments offers several benefits. We hope that our observations can give insights into building better tool support for scattered code fragments.

REFERENCES

• 1: Eclipse task tags website. http://127.0.0.1:55317/help/index.jsp?topic=/org.eclipse.jdt.doc.user/reference/refpreferences-task-tags.htm.
• 2: William G. Griswold, Coping with Crosscutting Software Changes Using Information Transparency, Proceedings of the Third International Conference on Metalevel Architectures and Separation of Crosscutting Concerns, p.250-265, September 25-28, 2001
• 3: William G. Griswold , Jimmy J. Yuan , Yoshikiyo Kato, Exploiting the map metaphor in a tool for software evolution, Proceedings of the 23rd International Conference on Software Engineering, p.265-274, May 12-19, 2001, Toronto, Ontario, Canada
• 4: G. Kiczales, J. Lamping, A. Menhdhekar, C. Maeda, C. Lopes, J.-M. Loingtier, and J. Irwin. Aspect-oriented programming. In European Conference on Object-Oriented Programming, pages 220--242, 1997.
• 5: Martin P. Robillard , Gail C. Murphy, Concern graphs: finding and describing concerns using structural program dependencies, Proceedings of the 24th International Conference on Software Engineering, May 19-25, 2002, Orlando, Florida [doi>10.1145/581339.581390]
• 6: Peri Tarr , Harold Ossher , William Harrison , Stanley M. Sutton, Jr., N degrees of separation: multi-dimensional separation of concerns, Proceedings of the 21st international conference on Software engineering, p.107-119, May 16-22, 1999, Los Angeles, California, United States [doi>10.1145/302405.302457]

INDEX TERMS

Primary Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.3 Coding Tools and Techniques
          Subjects: Structured programming

Additional Classification:
  D. Software
  D.2 SOFTWARE ENGINEERING
      D.2.3 Coding Tools and Techniques
          Subjects: Standards

General Terms:
Design, Documentation, Standardization