C Source Typesetting Guide

/*
	Main Header at the beginning of the program file.

	This makes reading a large block about the program
	easy but is discouraged throughout the program as 
	the lines between code and comments may blur
*/


/* >>>>> Major Section Header Like Main  <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< */

/*----------------------------------------------------------------------------
 Light Block (good for notes)
 ----------------------------------------------------------------------------*/

/* Simple One Line Comment for simple explanations */

/* also good for marking the end of functions and iterations */


/*****************************************************************************
 * function explanation
 * A Block right before a function
 *****************************************************************************/


/* 
 * A medium level comment we use to explain a bunch
 * of code that follows, may work better if there is
 * a lot to explain
 */
	

/* 
 * A Block for Explaining an Entire Section
 * ^ ^^^^^^^^^ ^^^^^^^^^^ ^^ ^^^^^^ ^^^^^^^
 * 
 * Here we give mind numbing detail
 * About the whole section so we can really
 * confuse the reader!
 */


/*************************************************************************
 *************************************************************************
 ****** Warning ! ! ! 
 ****** Danger Will Robinson: 
 ****** Here is the message, beware of something
 *************************************************************************
 *************************************************************************/