OOP344 - Team Nothing - 20102

From CDOT Wiki
Revision as of 19:06, 30 May 2010 by Acchung1 (talk | contribs) (4.0 Conventions and Styles)
Jump to: navigation, search

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


1.0 Participants

1.1 Team Members

OOP344 - Team Nothing - 20102
ID First Name Last Name Section Seneca Id wiki id IRC nick Blog URL
A Alex Chung A acchung1 acchung1 acchung1 my blog
B Don Armin Napao A danapao danapao danapao My Blog
C Robin Co A rco1 imadorki3 rco1 My Blog
D Bhavanesh Patel A bapatel5 bapatel5 Bhavanesh My Blog
E Kerry Singh A kmsingh sinker sinker My Blog


1.2 Team Contact Person

Kerry Singh
IRC Nick: sinker


2.0 Project Development Page

Project Development Page


3.0 IRC Chatlogs / Meeting Logs

IRC meeting logs


4.0 Conventions and Styles

4.1 Function Naming Convention

Function names are all lowercase and each word are separated by a _

int function_name()
{
  code;
}

4.2 Variable Convention

4.2.1 Naming Convention

Similar to the 4.1 Function Naming Convention

For Compound:

int some_var;

OR

For Single:

int var;

4.2.2 Creating

Each variable should be on it's own line

int var1;
int var2;

4.3 Indent Level

The indent level in any case will consist of three spaces. There will be no tab use.

int someFunction
{

   code;
   more code;

}

4.4 File Heading

Each file with the extension of *.cpp, *.c, and *.h must include a comment heading stating the file name, author (and username), date created, last modified date, and description of what the file does. The description should be clear and concise. This must be enclosed using /* and */.

/*
 * File Name: example.cpp
 * Author: Name (senecaid)
 * Create Date: 23-May-10
 * Last Modified Date: 11-Nov-10
 * Description: blah blah blah
 */

4.5 Function Comments

Each function should include a comment above the function similar to the file heading (4.4 File Heading), except only including the function name, what each variable does in the function, and a description of what the function does

/*
 * Function Name: function_name
 * Description: Blah blah blah.
 * Variable: variable1 - this does this to this function
 *           variable2 - this is 2
 */
int function_name()
{

  code;

}

4.6 Curly Braces

Use of { } in a code block, such as in an if statement, a for loop, should start on a new line, with the { } lined up with the first character of the line above it. If the code block only has one coded line for the result, please use the curly brackets anyways for readability’s sake.

void function()
{
   if(some-condition)
   {
      code;
   }
}

if(some-condition)
{
   code;
}
else
{
   code;
}

4.7 Conditional Compilation

#ifndef _tn_headerfilename_h