C Now

A Commented C Program

Comments

Comments are treated as white space (e.g., blanks) by the compiler, and are otherwise ignored.
Comments begin with a slash star (/*) and end with a star slash (*/).
Example:
/* This is a "multiline" comment. */
Example:
/* This is a multiline comment */
Multiline comments cannot be nested:
Example:
/* This is /* illegal */ in C */
Style: Comments should explain why something is being done, not what is being done. (The code tells what is being done.)

/***************************************************************
 * File:    comments.cpp
 * Purpose: A program to illustrate the use of comments.
 * Author:  John Young
 * Date:    May 24, 2004
 ***************************************************************/

int main () {
  return 0;          // 0 indicates success
}

Style: Program files should begin with a comment identifying the file, its description, author, date, and any other useful information.

C Now Home

Tutorial Index