Changes

Jump to: navigation, search

OOP344 Temporary CodingStandards

10 bytes removed, 15:51, 29 October 2009
OOP344 northWind87: Raised all elements one level higher
While no one will be prosecuted or killed if they forget one or more of these, the others will gently '''remind''' the person in question to '''follow the guidelines''' :)
== Naming Conventions ==
* ''' Camel Notation ''' should be used for variable names and function names
** ''' ie ''' <code>myVar, bigInt, getNumber(), myFunction()</code>
** ''' ie ''' <code>__CIOL_H__, __IO_FORM_H__</code>
== Other Conventions ==
* Pointer declaration should ''' emphasize the type ''' with the <b>"*"</b> being pushed against the right side of the data type as opposed to the left side of the variable name.
** ''' ie ''' <code>char* str, int* num, void* addr</code>
** ''' ie ''' <code>void doStuff(void), int getInt(void)</code>
== Statement Notation ==
The first left parenthesis on a function declaration should open immediately after the function name while the first left parenthesis on a loop declaration should open one space after the loop declaration.<br />
''' ie Functions: '''
''' ie ''' <code>x = getInt(), someInt = y + bigSum(y, r)</code>
== Code Blocks ==
Both function blocks and loop blocks should open on the same line as the declaration statement preceding them; however, function blocks should open immediately after the last right parenthesis while loop blocks should open one space after the last right parenthesis.<br />
''' ie Functions: '''
do (blah) {</pre>
== Comment Blocks ==
All functions should have a comment block preceding them which should explain what the function does in a few brief sentences, what parameters it receives with each parameter having a section preceded by <code>@param</code>, and anything that the function may return preceded by <code>@return</code> at the end of the block. Try to keep things lined up so that they're easier to read.

Navigation menu