From WinBolo

Revision as of 21:54, 11 February 2009 (view source) Sticks (Talk | contribs) (→Method Header Comments) ← Previous diff		Revision as of 21:57, 11 February 2009 (view source) Sticks (Talk | contribs) (→Single Line Comments) Next diff →
Line 22:		Line 22:
	== Single Line Comments ==		== Single Line Comments ==
		+
		+	As this code is trying to be 100% ANSI C compliant, you [b]must[/b] use a forward slash immediately followed by an asterisk to start the comment and then an asterisk and forward slash to close the comment.
		+	<pre>
		+	/* This is a comment and will be ignored by the compiler */
		+	</pre>
	== Multiline Comments ==		== Multiline Comments ==

---

Revision as of 21:57, 11 February 2009

Contents 1 Comments 1.1 Method Header Comments 1.2 File Header Comments 1.3 Single Line Comments 1.4 Multiline Comments 2 Variable Cases 3 Indentions 3.1 Conditionals 3.2 Methods

Comments

Method Header Comments

This should go above every method, both it's implementation (in .c files) and definition (in .h files).

/*********************************************************
*NAME:          <functionName>
*AUTHOR:        <functionAuthor>
*CREATION DATE: <DD/MM/YY>
*LAST MODIFIED: <DD/MM/YY>
*PURPOSE:
*  Short description of function goes here
*
*ARGUMENTS:
*  firstParameter  - Short explanation of what this parameter is
*  secondParameter - Short explanation of what this parameter is
*********************************************************/

File Header Comments

Single Line Comments

As this code is trying to be 100% ANSI C compliant, you [b]must[/b] use a forward slash immediately followed by an asterisk to start the comment and then an asterisk and forward slash to close the comment.

/* This is a comment and will be ignored by the compiler */

Multiline Comments

Variable Cases

Indentions

Conditionals

Methods