Comment (computer programming)

source code with prologue comments indicated in red and inline comments in green. Program code is in blue.]]

In computer programming, a comment is a programming language construct used to embed programmer-readable annotations in the source code of a computer program. Those annotations are potentially significant to programmers but typically ignorable to compilers and interpreters. Comments are usually added with the purpose of making the source code easier to understand. The syntax and rules for comments vary and are usually defined in a programming language specification (see the syntax of comments in various programming languages).

Comments have a wide range of potential uses: from augmenting program code with basic descriptions, to generating external documentation. Comments are also used for integration with source code management systems and other kinds of external programming tools.

The flexibility provided by comments often allows for a wide degree of variability and potentially non-useful information inside source code. To address this, many technical commentators and software analysts subscribe to any of several "philosophies" and guidelines regarding the proper use of comments.

Overview

Comments are generally formatted as block comments (also called prologue comments or stream comments) or line comments (also called inline comments).

Block comments delimit a region of source code in which the region is allowed to span multiple lines. This region is specified with a start delimiter and an end delimiter. Some programming languages (such as MATLAB) allow block comments to be recursively nested inside one another, but others (such as Java) do not.

Line comments either start with a comment delimiter and continue until the end of the line, or in some cases, start at a specific column (character line offset) in the source code, and continue until the end of the line. There are many different ways of writing comments and many commentators who offer sometimes conflicting advice.

:"Good comments don't repeat the code or explain it. They clarify its intent. Comments should explain, at a higher level of abstraction than the code, what you're trying to do."

Comments may also be used to explain why a block of code does not seem to fit conventions or best practices. This is especially true of projects involving very little development time, or in bug fixing. For example: ' Second variable dim because of server errors produced when reuse form data. No ' documentation available on server behavior issue, so just coding around it. vtx = server.mappath("local settings")

Algorithmic description

Sometimes source code contains a novel or noteworthy solution to a specific problem. In such cases, comments may contain an explanation of the methodology. Such explanations may include diagrams and formal mathematical proofs. This may constitute explanation of the code, rather than a clarification of its intent; but others tasked with maintaining the code base may find such explanation crucial. This might especially be true in the case of highly-specialized problem domains; or rarely-used optimizations, constructs or function-calls.

For example, a programmer may add a comment to explain why an insertion sort was chosen instead of a quicksort, as the former is, in theory, slower than the latter. This could be written as follows: list = [f (b), f (b), f (c), f (d), f (a), ...]; // Need a stable sort. Besides, the performance really does not matter. insertion_sort (list);

=== Resource inclusion ===

Logos, diagrams, and flowcharts consisting of ASCII art constructions can be inserted into source code formatted as a comment. Further, copyright notices can be embedded within source code as comments. Binary data may also be encoded in comments through a process known as binary-to-text encoding, although such practice is uncommon and typically relegated to external resource files.

The following code fragment is a simple ASCII diagram depicting the process flow for a system administration script contained in a Windows Script File running under Windows Script Host. Although a section marking the code appears as a comment, the diagram itself actually appears in an XML CDATA section, which is technically considered distinct from comments, but can serve similar purposes.

ClientApp (async_run, batch_process) | | V mru.ini (mru_history) ]>

Although this identical diagram could easily have been included as a comment, the example illustrates one instance where a programmer may opt not to use comments as a way of including resources in source code. These may include insert positions for automatic header file inclusion, commands to set the file's syntax highlighting mode, or the file's revision number. These functional control comments are also commonly referred to as annotations. Keeping documentation within source code comments is considered as one way to simplify the documentation process, as well as increase the chances that the documentation will be kept up to date with changes in the code.

Examples of documentation generators include the programs Javadoc for use with Java, Ddoc for D, Doxygen for C, C++, Java, IDL, and PHPDoc for PHP.

C# and Visual Basic implement a similar feature called "XML Comments" which are read by IntelliSense from the compiled .NET assembly.

Normative views

There are various normative views and long-standing opinions regarding the proper use of comments in source code. Some of these are informal and based on personal preference, while others are published or promulgated as formal guidelines.

Need for comments

Technical commentators have documented varying viewpoints on whether and when comments are appropriate in source code. Some commentators assert that source code should be written with few comments, on the basis that the source code should be self-explanatory.

In between these views is the assertion that comments are neither beneficial nor harmful by themselves, and what matters is that they are correct and kept in sync with the source code, and omitted if they are superfluous, excessive, difficult to maintain or otherwise unhelpful.

Level of detail

Depending on the intended audience of the code and other considerations, the level of detail and description may vary considerably.

For example, the following Java comment would be suitable in an introductory text designed to teach beginning programming:

String s = "Wikipedia"; /* Assigns the value "Wikipedia" to the variable s. */

This level of detail, however, would not be appropriate in the context of production code, or other situations involving experienced developers. Such rudimentary descriptions are inconsistent with the guideline: "Good comments ... clarify intent." The occurrence of this phenomenon can be easily seen from online resources that track profanity in source code.

Comments in web templates

Web development presents a special security challenge related to comments, because it is not uncommon for HTML comments to be viewable in plain text by any user of the application. Sections of code that are "commented out" in HTML templates may therefore present a security vulnerability.

Styles

There are many stylistic alternatives available when considering how comments should appear in source code. For larger projects involving a team of developers, comment styles are either agreed upon before a project starts, or evolve as a matter of convention or need as a project grows. Usually programmers prefer styles that are consistent, non-obstructive, easy to modify, and difficult to break.

The following code fragments in C demonstrate just a tiny example of how comments can vary stylistically, while still conveying the same basic information: /* This is the comment body. Variation One.

/

/***************************\

*

This is the comment body. *

Variation Two. *

*

\***************************/

Factors such as personal preference, flexibility of programming tools, and other considerations tend to influence the stylistic variants used in source code. For example, Variation Two might be disfavored among programmers who do not have source code editors that can automate the alignment and visual appearance of text in comments.

Software consultant and technology commentator Allen Holub is one expert who advocates aligning the left edges of comments:

/* This is the style recommended by Holub for C and C++. * It is demonstrated in Enough Rope, in rule 29. */

/* This is another way to do it, also in C. ** It is easier to do in editors that do not automatically indent the second ** through last lines of the comment one space from the first. ** It is also used in Holub's book, in rule 31. */

End-of-line

In this form, all the text from the ASCII characters // to the end of the line is ignored. /// begin: Variation Three. /// ------------------------- /// This is the comment body. /// -------------------------

Different styles can be chosen for different areas of code, from individual lines to paragraphs, routines, files, and programs. If the syntax supports both line comments and block comments, one method is to use line comments only for minor comments (declarations, blocks and edits) and to use block comments to describe higher-level abstractions (functions, classes, files and modules).

Sometimes projects try to enforce rules like "one comment every ten lines". These kinds of rules can be counterproductive when too rigorous, but may provide a useful standard of measurement and consistency if the project participants deem it necessary.

Tags

Certain tags are used in comments to assist in indexing common issues. Such tags are commonly syntax-highlighted within text editors and can be searched with common programming tools, such as the Unix grep utility. Examples of tag conventions include:

FIXME to mark potential problematic code that requires special attention and/or review.

NOTE to document inner workings of code and indicate potential pitfalls.

TODO to indicate planned enhancements.

XXX to warn other programmers of problematic or misguiding code.

There is a risk that tags accumulate over time; it is advisable to include the date and the tag owner in the tag comment to ease tracking.

Examples

Comparison

Typographic conventions to specify comments vary widely. Further, individual programming languages sometimes provide unique variants. For a detailed review, please consult the programming language comparison article.

In context

BASIC classic

This BASIC code fragment is a completely functioning program in which the comments describe what the program does for the benefit of novice programmers. 10 REM This BASIC program shows the use of the PRINT and GOTO statements. 15 REM It fills the screen with the word "WIKIPEDIA" 20 PRINT "WIKIPEDIA" 30 GOTO 20 When run, this program repeatedly prints the word "WIKIPEDIA" (without quotes) in an infinite loop.

C

This C code fragment demonstrates the use of a prologue comment or "block comment" to describe the purpose of a conditional statement. The comment explains key terms and concepts, and includes a short signature by the programmer who authored the code. /* * Check if we are over our maximum process limit, but be sure to * exclude root. This is needed to make it possible for login and * friends to set the per-user process limit to something lower * than the amount of processes root is running. -- Rik */ if (atomic_read(&p-;>user->processes) >= p->rlim[RLIMIT_NPROC].rlim_cur && !capable(CAP_SYS_ADMIN) && !capable(CAP_SYS_RESOURCE)) goto bad_fork_free; This excerpt is from the fork.c file from the Linux kernel source.

ColdFusion

ColdFusion uses comments similar to HTML/XML, but instead of two dashes, it uses three. These comments are caught by the ColdFusion engine and not printed to the browser.

Hello World

Fortran IV

This Fortran IV code fragment demonstrates how comments are used in that language, with the comments themselves describing the basic formatting rules. C C Lines that begin with 'C' (in the first or 'comment' column) are comments C WRITE (6,10) 10 FORMAT(12H HELLO WORLD) END

Fortran 90

This Fortran code fragment demonstrates how comments are used in that language, with the comments themselves describing the basic formatting rules. !* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * !* All characters after an exclamation mark are considered as comments * !* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

PRINT "WIKIPEDIA" ! Fortran 90 introduced the option for inline comments. END

Java

This Java code fragment shows a block comment used to describe the setToolTipText method. The formatting is consistent with Sun Microsystems Javadoc standards. The comment is designed to be read by the Javadoc processor. /** * Registers the text to display in a tool tip. The text * displays when the cursor lingers over the component. * * @param text the string to display. If the text is null, * the tool tip is turned off for this component. */ public void setToolTipText(String text) {

Objective Caml

OCaml uses nestable comments, which is useful when commenting a code block. codeLine(* comment level 1(*comment level 2*)*)

Perl

Line comments in Perl, and many other scripting languages, begin with a hash (#) symbol. A comment at the beginning, called the shebang, tells the system what interpreter to use. #!/usr/bin/perl my $s = "Wikipedia"; # Sets the variable s to "Wikipedia". print $s . "\n"; # Add a newline character after printing for shells that do not do so automatically.

PHP

Comments in PHP can be either in C++ style (both inline and block), or in Perl style. PHPDoc is a style adapted from Javadoc and is a common standard for documenting PHP code.

Python

Comments in Python use the hash character. Python programs start with #! to tell the operating system which interpreter to use. #!/usr/bin/env python

# this program prints "Hello World" to the screen and then quits. print "Hello World!"

Python also supports docstrings a special sort of comment usually enclosed in triple-quotes (''').

def foo(x, y): '''Frobnicate the bar and baz together with one another''' return frob(frob(x), frob(y))

Ruby

Comments in Ruby.

Single line commenting: (line starts with hash "#") This is not a comment

#this is commented

This is not a comment

Multi-line commenting: (comments goes between keywords "begin" and "end") This is not a comment

=begin

whatever goes in here

will be ignored :)

=end

This is not a comment

SQL

Comments in SQL are in single-line-only form, when using two dashes: -- This is a single line comment -- followed by a second line SELECT COUNT(*) FROM Authors WHERE Authors.name = 'Smith'; -- Note: we only want 'smith' -- this comment appears after SQL code The syntax for Transact-SQL also supports alternative formats for specifying comments. One format supported by this syntax is identical to the "block comment" style used in the syntax for C++ and Java. /* This is a comment line 1 This is a comment line 2

/

SELECT COUNT(*) FROM Authors

Haskell

Single line comments in Haskell start with '--' (two dashes), and multiple line comments start with '{-' and end with '-}'. {- this is a comment on more lines -} -- and this is a comment on one line putStrLn "Wikipedia"

See also

Comment

Docstring, a specific type of comment that is parsed and retained throughout the runtime of the program.

HTML comment tag

Literate programming, alternative documentation paradigm

Syntax of comments in various programming languages

Notes and references

External links

How to Write Comments by Denis Krukovsky

Source Code Documentation as a Live User Manual by PTLogica

How to Write Comments for the Javadoc Tool

Doxygen, a documentation system for C, C++, Java, Objective-C, Python, IDL and to some extent PHP, C#, and D

Comment-driven development, a personal presentation of good coding practice

Category:Source code Category:Articles with example code Category:Articles with example C code Category:Articles with example Java code Category:Articles with example Perl code Category:Metadata Category:Reference