OOP344 - !YOU

From CDOT Wiki
Revision as of 14:00, 25 January 2010 by Fmdeoliveira (talk | contribs) (Added IRC section)
Jump to: navigation, search

This is Team !YOU's Project Page

You will find all project related information here

STOP USING THIS PAGE

use http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_Team_!YOU

Team Members

OOP344 - 2010 Team !YOU
Last Name Name Seneca ID Section Blog URL IRC nick My Contributions
Adams Matthew mdadams1 A http://www.tandemwebdesign.ca/blog MattAdams Contributions
Catibog Timothy tjcatibog A http://tjprogramming.blogspot.com/ tjcatibog Contributions
Daniels Matthew mddaniels A http://cdnpadawan.wordpress.com/ CDNPadawan Contributions
De Oliveira Felipe fmdeoliveira A http://feliploko.wordpress.com/ fmDeOliveira Contributions
Misko Andrew ammisko A http://ammisko.blogspot.com ammisko Contributions
Simmalavong Niki nsimmalavong A http://oop344-niki.blogspot.com/ nsimmalavong Contributions
Ward Amy amward1 A http://amward1.wordpress.com/ award Contributions
Ziaei Minoo mziaei1 A http://minooz.wordpress.com/ Minooz Contributions


IRC

Our IRC channel is #oop344_!you on freenode. Please join the channel whenever you are on IRC.

IRC Meetings

We need to decide when we should have our meetings.

Discussion
Name Comment
fmDeOliveira Evenings work better for me... It is hard to find some time in the morning or afternoon that all or most of us are able to be on IRC.


Team Programming Standards

An area for listing our teams programming standards that we will use when constructing the project. Please follow these rules when writing code for this project. This will make it easier for us to help each other and collaborate in the whole process.

Declare only one variable in each line.

This makes it easier to scan the code and find the type of a variable that you see somewhere else in the code.

Do:

 int a;
 int b = 0;
 int c = a;

Don't:

 int a, b = 0, c = a;

Do not use tabs when indenting.

The tab space is interpreted different across different software and operating systems. Use 2 spaces to add indentation instead.

Do:

 main() {
   int i = 0;
   if (i < 5) {
     printf("Hey you!\n");
   }
 }

Put the pointer identifier(*) right after the target variable type.

Pointers are hard enough to deal with. It only makes it more complicated if they are declared differently throughout the code.

Do:

 int* p1;
 char* p2;

Don't:

 int *p1;
 char *p2;

(Discussion: Use of iterating variables on for loops)

There are two major ways of dealing with the iteration variable on for loops. We should come to a consensus on how to deal with it on our project.

Option 1: Declare the variables outside the loop; initialize them inside the loop; keep their exit values for future use.

 int i;
 for (i = 0; i<5; i++) printf("."); // Prints .....
 printf("%d",i); // Prints 5

Option 2: Declare and initialize variables inside the loop; lose the variable at the end of the loop scope;

 for (int i = 0; i<5; i++) printf("."); // Once the loop is done, variable i cannot be accessed anymore.
Discussion
Name Comment
fmDeOliveira I definitely prefer option 2. It is much easier to keep recycling the loop variables without having to worry if they already exist or not. In case we need the value of the loop variable after the loop is done, we should just copy it to another variable before the end of the loop.

(Discussion: Variable names)

How should we name the variables that we create on our project?


Discussion
Name Comment
fmDeOliveira I suggest we avoid abbreviations, since what might be obvious for some could be confusing for others. Full words or short expressions could be used where the first letter is always lower case, and the first letter of the following words are upper case. Examples: cost, totalPrice, numberOfPeople.

(Discussion: Use of comments)

When should we use double slash (//) and when should we use slash-asterisk (/* */)?


Discussion
Name Comment
fmDeOliveira I prefer using // for single-line comments and /* */ for blocks of commented code. This would avoid problems commenting out blocks of code that already have single-line comments (the end of the single-line comment would not be interpreted as the end of the block comment).