How people who use the comment element

Linus Chan

Source code comments are comments found in a program, written by the programmer which does not directly affect the program. They are static creations that stand the test of time. However, despite their static nature, the approach to writing source code comments has begun to change. In "Do Code and Comments Co-Evolve?", we are given a glimpse on how open source systems are beginning to change.

However, more than just that, we see how educational structures centered around commenting are also changing. Classes at the University of Minnesota emphasize good commenting practice. In fact, students are graded on how well they utilize this element!

This element, even though it has been in existence since the inception of HTML as a markup language, still causes a huge degree of controversy especially to students. "As long as it works, why does it matter if I don't comment in it?" This is a phrase that is often heard, especially in an academic setting.

One result that really does strike an interesting point is that "newly added code barely gets commented on" (Passion for Coding). While the original author may have the authorial gravitas to enact changes, the open source contributors pivot in an entirely other direction. Source code and the comments within the same program do not seem to evolve. However, source code as a whole does share some intimate relationships with comments.

In another study, it's clearly stated that, "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." (Pseudo-comments in CSS)

Simply put, developers often lack the authorial intent to feel the need or the ability to place comments on source code. It can experience fluctuation based on an a abnormally active developer, but it really does remain static.

The last way that the comment element is used in programming, especially in HTML is to render pieces of code inert. By adding the comment element around a piece of code, it enables programmers to quickly revise and cut out pieces of code that may not be working or are obsolete.

Next Page