Difference between revisions of "OOP344 - HOTYS - 20102"

From CDOT Wiki
Jump to: navigation, search
(Coding Style Rules: Version 4)
(Coding Style Rules: v5 more rules added)
Line 93: Line 93:
  
 
Function names should have meaningful names (they do not require prefix)
 
Function names should have meaningful names (they do not require prefix)
 +
Function names Should be all lower case except for the First letter of each Word.
 
Each function should have only one point of entry and one point of exit.
 
Each function should have only one point of entry and one point of exit.
 
I.E. There should be only 1 return statement in each function.
 
I.E. There should be only 1 return statement in each function.

Revision as of 16:37, 23 May 2010


OOP344 | Weekly Schedule | Student List | Teams | Project | Student Resources

This is team HOTYS homepage!!!

The Name of the team is derived from the first letter of each group member's name:

Han Chul Kim
Osman Mirza
Tony Kim
YuJin Jeong
Stephanie Law


Member List

OOP344 - 2010 Team HOTYS -
Last
Name
Name Seneca
Username
Section Blog Url IRC Nick My Contributions
a Kim Han hckim3 A http://hckim.wordpress.com/ han3 Hckim3
b Mirza Ozzy omirza A http://0zzym.wordpress.com/ OzZy_M OzZy
c Kim Tony kjkim A My Blog TonyKim kjkim
d Jeong YuJin yjeong A Spirit & Soul YuJin Takeiteasy
e Law Stephanie slaw12 - A My Blog- Slaw12 slaw12

Team Project

Team Project


Discussions

Discussion Page


IRC Schedule/Log

IRC Page

Coding Style Rules

Every file should have a function header with:
File name
Programmer Full name
Date last modified

Variable names should be meaningful so additional comments are not necessary to explain what the variable does

A lower case prefix should be fitted to the variable name to help describe it at a glance:
n int
c character
b Boolean
f fload
d double
s C-style null terminated string OR a string object
p Pointers

Ex:
nNumOfSignals
cCharPassed
bIsTrue
fLength
dWidth
sUserInput
pnNumOfSignals

Also for Classes, ALL Data Member should have a m_ prefixed to the name to show that it is a Data Member ( Instance Variables )
Ex:
int m_nType;
NOT
int nm_Type OR INT mn_Type;

All variable declaration should be done on it's own line

There should be NO single character names for variables (Ex: i, j, k, etc) except for arbitrary counters, such as for loops

All const and #define Variable names should be in All Caps
ex:
const int MAX_TRIPS;
#define MAX_TRIPS 1

Pointers should be defined in C++ style:
int* x;
NOT
int * x; OR int *x;


Function names should have meaningful names (they do not require prefix)
Function names Should be all lower case except for the First letter of each Word.
Each function should have only one point of entry and one point of exit.
I.E. There should be only 1 return statement in each function.

Each function should have a header describing what it does.

Use Inline comments to describe hard to read code.  All inline code should be set to the same indention as the code it is describing. 


Opening braces should be on the same line as the defining function/if/else if/etc statement.
Ex:
void FunctionOne(int){
if (x > y){
NOT
void FunctionOne(int)
{
if (x > y)
{


There should be NO use of the tab character!!!
Each indent should be 3 blank spaces!  I will write a wiki on how to set this up in VS 2008, VS 2010,And Notepad++