Team !YOU - OOP344
This is Team !YOU's Project Page
You will find all project related information here
- 1 Team Members
- 2 IRC
- 3 Team Programming Standards
- 3.1 Declare only one variable in each line.
- 3.2 Do not use tabs when indenting.
- 3.3 Put the pointer identifier(*) right after the target variable type.
- 3.4 (Discussion: Use of iterating variables on for loops)
- 3.5 (Discussion: Variable names)
- 3.6 (Discussion: Use of comments)
- 3.7 (Discussion: Indentation)
|Last Name||Name||Seneca ID||Section||Blog URL||IRC nick||My Contributions|
Our IRC channel is #oop344_!you on freenode. Please join the channel whenever you are on IRC.
We need to decide when we should have our meetings.
|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.|
|ammisko||Evening are also good for me. I don't have class later than 320 every day. As long as I know a few days in advance I shouldn't have a problem with meeting any time after 320.|
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.
int a; int b = 0; int c = a;
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 normal spaces to add indentation instead.
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.
int* p1; char* p2;
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; // counter 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.
|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.|
|ammisko||I like option 1 better (I changed it a bit). I think it looks cleaner and is much easier to read for someone who doesn't know what the code does (especially with comments). Also what if we need to use a loop variable from outside the for loop? Or if we need to use the first part of the for-loop for other code? Option 1 could accommodate that better I think.|
(Discussion: Variable names)
How should we name the variables that we create on our project?
|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 (/* */)?
|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).|
Something simple, but that should be standard for all pieces of the code.
|fmDeOliveira||I usually put two spaces for a new indent, and keep a blank line between new big blocks of code and whatever comes before it (usually an if statement, a for loop, or the signature of a function).|