[an error occurred while processing this directive]


<!Converted to html format by: Sue Bogar 2/12/96->
<!Modified 1/28/97 SAB ->

<center>
<H1>CMSC 201 - C Coding Standards</H1>
</center>


<H2>Naming Conventions</H2>

<UL><LI>Begin variable names with lowercase letters
    <LI>Begin function names with uppercase letters
    <LI>Use all uppercase for symbolic constants (#define)
    <LI>Do not use global variables
    <LI>Use meaningful identifiers
    <LI>Be consistent!
    <LI>Separate "words" within identifiers with underscores or mixed upper
        and lowercase.
    <LI>Examples:
    <UL>2-"word" variable name:  baudRate or baud_Rate <BR>
	2-"word" function name:  ProcessError or Process_Error 
    </UL>
</UL>

<H2>Use of Whitespace</H2>

<UL><LI>Use blank lines to separate major parts of a source file or function.
    <LI>Separate declarations from executable statements with a blank line.
    <LI>If possible, configure text editor to use spaces rather than tabs.
    <LI>Use tab stops of 3 or 4
    <LI>Preprocessor directives, function prototypes, and headers of function
	definitions begin in column 1.
    <LI>All statements in the body of a function are indented one tab stop;
	statements inside of a loop or part of an "if" structure are indented
	further.
</UL>

<H2>Use of Braces</H2>
<UL><LI>Always use braces to mark the beginning and end of a loop or "if"
	structure, even when not required.
</UL>

<H2>Comments</H2>
<UL><LI>Every source file should contain an opening comment describing the
	contents of the file and other pertinent information (author's name,
	creation date, history of changes, special notes or compilation
	instructions).
    <LI>Each function should have a header comment which states the purpose of
	the function and the details of its usage.
    <LI>Include additional comments to explain use of variables, to delineate
	the major parts of functions, and to help the reader understand 
	anything that's not obvious.
</UL>

[an error occurred while processing this directive]
Tuesday, 28-Jan-1997 17:52:37 EST