Difference between revisions of "OOP344 - HOTYS - 20102"
(→Member List - May 19) |
(→Coding Style Rules) |
||
Line 44: | Line 44: | ||
[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_20102 IRC Page] | [http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_20102 IRC Page] | ||
− | ==Coding Style Rules== | + | ==<big>Coding Style Rules</big>== |
− | < | + | <pre> |
− | + | Normal 0 false false false EN-CA X-NONE X-NONE MicrosoftInternetExplorer4 | |
− | </ | + | |
+ | 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 | ||
+ | |||
+ | |||
+ | |||
+ | Ex: | ||
+ | |||
+ | nNumOfSignals | ||
+ | |||
+ | cCharPassed | ||
+ | |||
+ | bIsTrue | ||
+ | |||
+ | fLength | ||
+ | |||
+ | dWidth | ||
+ | |||
+ | sUserInput | ||
+ | |||
+ | |||
+ | |||
+ | There should be NO single character names for variables (Ex: i, j, k, etc) except for arbitrary counters, such as for loops | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | |||
+ | Function names should have meaningful names (they do not require prefix) | ||
+ | |||
+ | 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++ | ||
+ | |||
+ | </pre> | ||
+ | |||
<br /> <br /> | <br /> <br /> |
Revision as of 15:01, 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
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
Discussions
IRC Schedule/Log
Coding Style Rules
Normal 0 false false false EN-CA X-NONE X-NONE MicrosoftInternetExplorer4 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 Ex: nNumOfSignals cCharPassed bIsTrue fLength dWidth sUserInput There should be NO single character names for variables (Ex: i, j, k, etc) except for arbitrary counters, such as for loops Function names should have meaningful names (they do not require prefix) 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++