Open main menu

CDOT Wiki β

Changes

OOP344 - HOTYS - 20102

4,487 bytes added, 17:11, 25 July 2010
IRC Schedule/Log: - Added Log 7
{{OOP344 Index}}
= <big>'''HOTYS Homepage'''</big> = <p>This is team Welcome to '''HOTYS''' homepage!!!</p>
<p>The Name of the team is derived from the first letter of each group member's name:</p>
<span style="font-size: 1.75em; font-weight: bolder;">S</span>tephanie Law <br />
<br />
 
 
== <big>Member List</big> ==
{| class="wikitable sortable" border="1" cellpadding="5"
|-
| c || Kim || Tony (Kijeong) || [mailto:kjkim@learn.senecac.on.ca kjkim] || A || [http://kijeongkim.blogspot.com/ My Blog] || TonyKim || [[Special:Contributions/kjkim| kjkim]]
|-
| d || Jeong || YuJin ||[mailto:yjeong@learn.senecac.on.ca yjeong] || A || [http://yujinjeong.wordpress.com/ Spirit & Soul] || YuJin_YJ_|| [[Special:Contributions/Takeiteasy| Takeiteasy ]]
|-
| e || Law || Stephanie ||[mailto:slaw12@learn.senecac.on.ca slaw12] - || A || [http://slaw12.wordpress.com/ My Blog]- ||Slaw12 ||[[Special:Contributions/slaw12| slaw12]]
|}
<br />
== <big>Team ProjectDevelopment Page</big> ==[http://zenit.senecac.on.ca/wiki/index.php/OOP244_OOP344_-_HOTYS_Project_Dev_Page_-_20101 Team Project]<br />
== <big>Discussions</big> ==
[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_Discussion_-_20102 Discussion Page]
<br />
== <big>IRC Schedule/Log</big> ==
<span style="font-size: 125%; font-weight: bolder; color: #FF0000; text-decoration: overline underline;">&nbsp;&nbsp;Group meetings will be held on Sundays at 12pm in #seneca-HOTYS.&nbsp;&nbsp;</span><br />Logs:<ul> <li>[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_052310_-_20102 Log 1] - This meeting mainly covered coding styles to be used and other group norms</li> <li>[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_053010_-_20102 Log 2] - This meeting mainly is us waiting for Fardad to show up. We later decided to split the functions and get to work since the assignment page was already up</li> <li>[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_060610_-_20102 IRC PageLog 3]- This meeting we went over the simple functions and added v0.1 in tags as a group. Had some Borland Problems we fixed.</li> <li>[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_060613_-_20102 Log 4] - This meeting we went over the distribution list.</li> <li>[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_062010_-_20102 Log 5] - This meeting was focused on fixing bugs and committing to trunk in preparation of Fardad's test main</li> <li>[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_071810_-_20102 Log 6] - This meeting we distributed the project's work and created a rough time line for completion.</li> <li>[http://zenit.senecac.on.ca/wiki/index.php/OOP344_-_HOTYS_IRC_Logs_-_072510_-_20102 Log 7] - This meeting we put together all classes and went over bugs to fix and features to add. HOTYS - TextEdit v0.2 was committed to trunk</ul><br />
==<big>Coding Style Rules</big>==
Every file should have a function header with:<prebr /><ul> Normal 0 false false false <li>File name</li> EN-CA X-NONE X-NONE MicrosoftInternetExplorer4<li>Programmer Full name</li> <li>Date last modified</li></ul>
Every Example:<br /><div><b style="color: #008800; line-height: 0.5em;"> <span style="color: #008800;">/*<br /> Title<br /> Title.h<br /> By: Full Name<br /> Date Last Modified: 9:59 AM April-15-10<br /> Description of what is in the file should have a function header with:<br /> */<br /> </span></b></div><br />
File nameVariable names should be meaningful so additional comments are not necessary to explain what the variable does.
Programmer Full nameExample:<div>Date last modified<b style="color: #000000; line-height: 0.5em;"> int nNum; <span style="color: #008800;">//Bad</span><br /> int nNumOfTypes <span style="color: #008800;">//Good</span><br /></b>Variable names should be meaningful so additional comments are not necessary to explain what the variable does</div>  <br />
A lower case prefix should be fitted to the variable name to help describe it at a glance:
<table border="1" cellspacing="3" cellpadding"5"> <tr style="border: 1px solid #000000; text-align: center;"> <th>Prefix</th> <th>Data Type</th> <th>Example</th> <tr style="border: 1px solid #000000; text-align: center;"> <td>n </td> <td>int</td> <td>nNumOfSignals</td> </tr> <tr style="border: 1px solid #000000; text-align: center;"> <td>c</td> <td>char</td> <td>cTypeMode</td> </tr> <tr style="border: 1px solid #000000; text-align: center;"> <td>b</td> <td>boolean</td> <td>bIsTrue</td> </tr> <tr style="border: 1px solid #000000; text-align: center;"> <td>f</td> <td>float</td> <td>fLength</td> </tr> <tr style="border: 1px solid #000000; text-align: center;"> <td>d</td> <td>double</td> <td>dWidth</td> </tr> <tr style="border: 1px solid #000000; text-align: center;"> <td>s</td> <td>C-Style null terminated string<br />OR a String object</td> <td>sUserInput</td> </tr> <tr style="border: 1px solid #000000; text-align: center;"> <td>p</td> <td>pointers</td> <td>pnNumOfSignals</td> </tr> <tr style="border: 1px solid #000000; text-align: center;"> <td>m_</td> <td>Data Member/<br />Instance Variable</td> <td>m_pnNumOfSignals<br /><b>NOT</b><br />pnm_NumOfSignals<br /><b>OR</b><br />mpn_NumOfSignals</td> </tr></table>
c characterAll variable declarations should be done on their own lines!
b BooleanThere should be NO single character names for variables (Ex: i, j, k, etc) except for arbitrary counters, such as for for loops
f floadAll const and #define Variable names should be in All Caps
d doubleExample:<br /><div><b style="color: #000000; line-height: 0.5em;"> const int nMAX_TRIPS;<br /> #define MAX_TRIPS 1<br /></b></div><br />
s C-style null terminated string OR a string object
ExPointers should be declared in C++ style:
nNumOfSignalsExample:<br /><div><b style="color: #000000; line-height: 0.5em;"> int* x;<br /> NOT<br /> int * x; OR int *x;<br /></b></div><br />
cCharPassedClass names should be all lower case except for the first letter, which should be upper case.
bIsTrueFunction names should have meaningful names (They do not require prefix).
fLengthFunction names Should be all lower case except for the First letter of each Word.
dWidthExample:<br /><div>sUserInput<b style="color: #000000; line-height: 0.5em;"> GetChar();<br /> NOT<br /> There should be NO single character names for variables getChar(); OR Getchar(Ex: i, j, k, etc) except for arbitrary counters, such as for loops    ;<br /> </b></div>Function names should have meaningful names (they do not require prefix)<br />
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. 
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.
Example:<br /><div><b style="color: #000000; line-height: 0.5em;"> //Comment<br /> GetChar();<br /> NOT<br /> //Comment<br /> GetChar()<br /></b></div><br />
Opening braces should be on the same line as the defining function/if/else if/etc statement.
ExExample:<br /><div><b style="color: #000000; line-height: 0.5em;"> void FunctionOne(int){<br />  if (x > y){<br />  NOT<br />  void FunctionOne(int)<br />  {<br />  if (x > y)<br />  {<br /></b>   </div>
<b>
There should be NO use of the tab character!!!
Each indent should be 3 blank spaces!</b>
Each indent should be 3 blank spaces! I will write a [http://zenit.senecac.on.ca/wiki on /index.php/How_to_set_up_tab_spaces This] shows how to set this up in VS 2008, VS 2010,And Notepad++ </pre>tab settings
<br /> <br />
1
edit