From WinBolo

Revision as of 22:21, 10 February 2009 (view source) Sticks (Talk | contribs) (initial settings) ← Previous diff		Revision as of 21:54, 11 February 2009 (view source) Sticks (Talk | contribs) (→Method Header Comments) Next diff →
Line 2:		Line 2:
	== Method Header Comments ==		== Method Header Comments ==
		+
		+	This should go above every method, both it's implementation (in .c files) and definition (in .h files).
		+	<pre>
		+	/*********************************************************
		+	*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
		+	*********************************************************/
		+	</pre>
	== File Header Comments ==		== File Header Comments ==

---

Revision as of 21:54, 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

Multiline Comments

Variable Cases

Indentions

Conditionals

Methods