Example: Inserting Comments

This example shows the correct way to insert block and inline comments into code:

 /*----------------------------------------------------------
 * Comment blocks need to have separating lines between
 * the text description. The separator can be a
 * dash '-' or an asterisk '*'
 *----------------------------------------------------------*/
 if ( statement )
 {
    statements
 } /* inline comments indicate the meaning of one statement */
 /*----------------------------------------------------------
 * Comments should be used in all segments of the source
 * code. The original programmer may not be the programmer
 * maintaining the code in the future which makes this a
 * crucial step in the development process.
 *----------------------------------------------------------*/
 /************************************************************
 * Function Clean Up
 ************************************************************/