Difference between revisions of "OOP344 - Team Nothing - 20102"

From CDOT Wiki
Jump to: navigation, search
(4.5 Function Comments)
(IOTextEdit Bugs / Completed Tasks)
 
(26 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[http://zenit.senecac.on.ca/wiki/index.php/OOP344 | OOP344] |  [http://zenit.senecac.on.ca/wiki/index.php/OOP344_Weekly_Schedule_20102 Weekly Schedule] |  [http://zenit.senecac.on.ca/wiki/index.php/Student_List_OOP344 Student List] |  [http://zenit.senecac.on.ca/wiki/index.php/Teams_OOP344 Teams] | [http://zenit.senecac.on.ca/wiki/index.php/Project_20102_OOP344 Project] |  [http://zenit.senecac.on.ca/wiki/index.php/IRC_Schedules_OOP344 IRC Schedules] |  [http://zenit.senecac.on.ca/wiki/index.php/Student_Resources_OOP344 Student Resources]
+
{{OOP344 Index}}
  
 
+
=Participants=
=1.0 Participants=
+
==Team Members==
==1.1 Team Members==
 
 
{| class="wikitable sortable" border="1" cellpadding="5" align="center"
 
{| class="wikitable sortable" border="1" cellpadding="5" align="center"
 
|+ OOP344 - Team Nothing - 20102
 
|+ OOP344 - Team Nothing - 20102
Line 9: Line 8:
 
|-
 
|-
 
| A ||[[User:acchung1 | Alex]] || Chung||  A || [mailto:acchung1@learn.senecac.on.ca acchung1] || [[Special:Contributions/acchung1 | acchung1]] || acchung1 || [http://acchung1.blogspot.com/ my blog]  
 
| A ||[[User:acchung1 | Alex]] || Chung||  A || [mailto:acchung1@learn.senecac.on.ca acchung1] || [[Special:Contributions/acchung1 | acchung1]] || acchung1 || [http://acchung1.blogspot.com/ my blog]  
|-
 
| B ||[[User:danapao | Don Armin]] || Napao || A||[mailto:danapao@learn.senecac.on.ca danapao] || [[Special:Contributions/danapao | danapao]] || danapao || [http://danapao026.blogspot.com/ My Blog]
 
 
|-
 
|-
 
| C||[[User:imadorki3 | Robin]] || Co || A||[mailto:rco1@learn.senecac.on.ca rco1] || [[Special:Contributions/imadorki3 | imadorki3]] || rco1 || [http://imadorki3.blogspot.com/ My Blog]
 
| C||[[User:imadorki3 | Robin]] || Co || A||[mailto:rco1@learn.senecac.on.ca rco1] || [[Special:Contributions/imadorki3 | imadorki3]] || rco1 || [http://imadorki3.blogspot.com/ My Blog]
 
|-
 
|-
 
| D||[[User:bapatel5 | Bhavanesh]] || Patel || A||[mailto:bapatel5@learn.senecac.on.ca bapatel5] || [[Special:Contributions/bapatel5 | bapatel5]] || Bhavanesh || [http://bhavanesh.wordpress.com/ My Blog]
 
| D||[[User:bapatel5 | Bhavanesh]] || Patel || A||[mailto:bapatel5@learn.senecac.on.ca bapatel5] || [[Special:Contributions/bapatel5 | bapatel5]] || Bhavanesh || [http://bhavanesh.wordpress.com/ My Blog]
|-
 
| E||[[User:Sinker | Kerry]]|| Singh || A ||[mailto:kmsingh@learn.senecac.on.ca kmsingh]|| [[Special:Contributions/sinker | sinker]] || sinker ||[http://kmsingh.blogspot.com/ My Blog]
 
 
|-
 
|-
 
|}
 
|}
  
 +
==Team Contact Person==
 +
Alex Chung - [mailto:acchung1@learn.senecac.on.ca acchung1]
 +
=Project Development Page=
 +
[[OOP344 - Team Nothing Project Development Page - 20102 | Project Development Page]]
 +
 +
=IRC Chatlogs / Meeting Logs=
 +
[[OOP344 - Team Nothing IRC Logs - 20102 | IRC meeting logs]]
 +
==30-May-2010==
 +
[[OOP344_-_Team_Nothing_IRC_Logs_-_20102#30-May-10 Channel: #Team-Nothing|Channel #Team-Nothing]]
 +
==10-June-2010==
 +
[[OOP344_-_Team_Nothing_IRC_Logs_-_20102#10-June-10 Channel: #Team-Nothing|Channel #Team-Nothing]]
 +
 +
We decided as a group to talk in class, or through e-mail as our means of communications because everyone is available at different times.
  
== 1.2 Team Contact Person ==
+
=Responsibilities=
 +
The responsibilities are based off of the different Classes. Each person is responsible for at least one of the class.
 +
If it is incomplete, they need to state it in the Bugs / Completed Tasks or somewhere that everyone can see.
 +
==The Application==
 +
===IOFrame===
 +
Name: Alex Chung
 +
====IOFrame Bugs / Completed Tasks====
 +
* completed the functions but have yet to test for bugs
 +
* unsure if the functions are created properly but it is compilable :)
 +
* need to make test program for this
 +
===IOField===
 +
Name: Alex Chung
 +
====IOField Bugs / Completed Tasks====
 +
* completed the functions but have yet to test for bugs
 +
* unsure if the functions are created properly but it is compilable :)
 +
* need to make test program for this
 +
*unsure of what it means by "enforces the children to do ..." '''*Solved*'''
  
'''[mailto:kmsingh@learn.senecac.on.ca Kerry Singh]''' <br/>
+
===IOLabel===
'''IRC Nick:  sinker'''
+
Name: Bhavanesh Patel
 +
====IOLabel Bugs / Completed Tasks====
  
 +
===IOEdit===
 +
Name: Bhavanesh Patel
 +
====IOEdit Bugs / Completed Tasks====
  
=2.0 Project Development Page=
+
===IOForm===
[[OOP244 - Team Nothing Project Dev Page - 20101 | Project Development Page]]
+
Name: Robin
 +
====IOForm Bugs / Completed Tasks====
  
 +
===IOVEdit===
 +
Name:
 +
====IOVEdit Bugs / Completed Tasks====
 +
===IOTextEdit===
 +
Name:
 +
====IOTextEdit Bugs / Completed Tasks====
 +
* BCKSPACE key bug fixed***
 +
* PG_DWN key is currently buggy and not working properly
  
=3.0 IRC Chatlogs / Meeting Logs=
+
===Linked List / Dynamic Array===
[[OOP344 - Team Nothing IRC Logs - 20102 | IRC meeting logs]]
+
Alex: I created a linked list but unsure if you want to use dynamic array
==3.1 30-May-10==
+
Each node stores 1 character
[[OOP344_-_Team_Nothing_IRC_Logs_-_20102#30-May-10 Channel: #Team-Nothing|Channel #Team-Nothing]]
+
 
 +
=Conventions and Styles=
 +
==Function Conventions==
 +
===Function Naming Convention===
 +
Function names are all lowercase and each word is separated by an underscore character.
  
=4.0 Conventions and Styles=
+
<pre>
==4.1 Function Naming Convention==
+
int do_something()
Function names are all lowercase and each word are separated by a _
+
{
 +
  code;
 +
}
 +
</pre>
  
 +
===Function Comments===
 +
Each function definition should include a comment above it that includes the function name, a brief and clear description of what each variable does in the function, and a clear and concise description of what the function does.
 
<pre>
 
<pre>
 +
/*
 +
* Function Name: function_name
 +
* Description: This is a clear and concise function description.
 +
* Variable: variable1 - this variable holds the value of something for some purpose
 +
*          variable2 - this variable holds the value of something else for some other purpose
 +
*/
 
int function_name()
 
int function_name()
 
{
 
{
 +
 
   code;
 
   code;
 +
 
}
 
}
 
</pre>
 
</pre>
  
==4.2 Variable Convention==
+
==Variable Conventions==
===4.2.1 Naming Convention===
+
===Naming Convention===
 
Similar to the [[OOP344_-_Team_Nothing_-_20102#4.1 Function Naming Convention|4.1 Function Naming Convention]]
 
Similar to the [[OOP344_-_Team_Nothing_-_20102#4.1 Function Naming Convention|4.1 Function Naming Convention]]
  
For Compound:
+
For Compound Variable Names:
 
<pre>
 
<pre>
 
int some_var;
 
int some_var;
Line 58: Line 112:
 
OR
 
OR
  
For Single:
+
For Non-compound Variable Names:
 
<pre>
 
<pre>
 
int var;
 
int var;
 
</pre>
 
</pre>
  
===4.2.2 Creating===
+
===Variable Definitions===
Each variable should be on it's own line
+
Define each variable on a speparate line.
  
 
<pre>
 
<pre>
Line 71: Line 125:
 
</pre>
 
</pre>
  
==4.3 Indent Level==
+
==File Headings==
The indent level in any case will consist of three spaces.  There will be no tab use.
+
Each file with the extension of *.cpp, *.c, and *.h must include a comment heading at the beginning of the file stating the file name, author (Team Nothing) and description of what the file does.  The description should be clear and concise.  This must be enclosed using /* and */.
 
 
<pre>
 
int someFunction
 
{
 
 
 
  code;
 
  more code;
 
 
 
}
 
</pre>
 
 
 
==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 */.
 
  
 
<pre>
 
<pre>
 
/*
 
/*
 
  * File Name: example.cpp
 
  * File Name: example.cpp
  * Author: Name (senecaid)
+
  * Author: Team Nothing
* Create Date: 23-May-10
+
  * Description: This is a clear and concise description of the file.
* Last Modified Date: 11-Nov-10
 
  * Description: blah blah blah
 
 
  */
 
  */
 
</pre>
 
</pre>
  
==4.5 Function Comments==
+
==Indentation Level==
Each function should include a comment above the function similar to the file heading ([[OOP344_-_Team_Nothing_-_20102#4.4 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
+
Use an indentation level of two spaces in all situations. Do not use TAB for indentation.
 +
 
 
<pre>
 
<pre>
/*
+
int some_function()
* Function Name: function_name
 
* Description: Blah blah blah.
 
* Variable: variable1 - this does this to this function
 
*          variable2 - this is 2
 
*/
 
int function_name()
 
 
{
 
{
  
  code;
+
  code;
 +
  more code;
  
 
}
 
}
 
</pre>
 
</pre>
  
==4.6 Curly Braces==
+
==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.
+
Each { and } for a code block, such as in an if statement or a for loop, should be placed on its own separate line, with the { and } lined up with the first character of the line above it.  If the code block consists of only one line of code, continue to use the curly braces for clarity and in case additional code is added afterwards.
 
<pre>
 
<pre>
 
void function()
 
void function()
Line 135: Line 170:
 
</pre>
 
</pre>
  
==4.7 Conditional Compilation==
+
==Conditional Compilation==
 +
===Naming Convention for Header Files===
 +
Prefix the names of header files that we create with "tn" (initials of Team Nothing) followed by an underscore character. For example, tn_headerfile.h
 +
 
 +
When using conditional compilation, use the following format for a file named tn_headerfile.h:
  
 
<pre>
 
<pre>
#ifndef _tn_headerfilename_h
+
#ifndef _TN_HEADERFILE_H_
 +
#define _TN_HEADERFILE_H_
 
</pre>
 
</pre>

Latest revision as of 11:14, 22 August 2010


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

Participants

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
C Robin Co A rco1 imadorki3 rco1 My Blog
D Bhavanesh Patel A bapatel5 bapatel5 Bhavanesh My Blog

Team Contact Person

Alex Chung - acchung1

Project Development Page

Project Development Page

IRC Chatlogs / Meeting Logs

IRC meeting logs

30-May-2010

Channel #Team-Nothing

10-June-2010

Channel #Team-Nothing

We decided as a group to talk in class, or through e-mail as our means of communications because everyone is available at different times.

Responsibilities

The responsibilities are based off of the different Classes. Each person is responsible for at least one of the class. If it is incomplete, they need to state it in the Bugs / Completed Tasks or somewhere that everyone can see.

The Application

IOFrame

Name: Alex Chung

IOFrame Bugs / Completed Tasks

  • completed the functions but have yet to test for bugs
  • unsure if the functions are created properly but it is compilable :)
  • need to make test program for this

IOField

Name: Alex Chung

IOField Bugs / Completed Tasks

  • completed the functions but have yet to test for bugs
  • unsure if the functions are created properly but it is compilable :)
  • need to make test program for this
  • unsure of what it means by "enforces the children to do ..." *Solved*

IOLabel

Name: Bhavanesh Patel

IOLabel Bugs / Completed Tasks

IOEdit

Name: Bhavanesh Patel

IOEdit Bugs / Completed Tasks

IOForm

Name: Robin

IOForm Bugs / Completed Tasks

IOVEdit

Name:

IOVEdit Bugs / Completed Tasks

IOTextEdit

Name:

IOTextEdit Bugs / Completed Tasks

  • BCKSPACE key bug fixed***
  • PG_DWN key is currently buggy and not working properly

Linked List / Dynamic Array

Alex: I created a linked list but unsure if you want to use dynamic array Each node stores 1 character

Conventions and Styles

Function Conventions

Function Naming Convention

Function names are all lowercase and each word is separated by an underscore character.

int do_something()
{
  code;
}

Function Comments

Each function definition should include a comment above it that includes the function name, a brief and clear description of what each variable does in the function, and a clear and concise description of what the function does.

/*
 * Function Name: function_name
 * Description: This is a clear and concise function description.
 * Variable: variable1 - this variable holds the value of something for some purpose
 *           variable2 - this variable holds the value of something else for some other purpose
 */
int function_name()
{

  code;

}

Variable Conventions

Naming Convention

Similar to the 4.1 Function Naming Convention

For Compound Variable Names:

int some_var;

OR

For Non-compound Variable Names:

int var;

Variable Definitions

Define each variable on a speparate line.

int var1;
int var2;

File Headings

Each file with the extension of *.cpp, *.c, and *.h must include a comment heading at the beginning of the file stating the file name, author (Team Nothing) 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: Team Nothing
 * Description: This is a clear and concise description of the file.
 */

Indentation Level

Use an indentation level of two spaces in all situations. Do not use TAB for indentation.

int some_function()
{

   code;
   more code;

}

Curly Braces

Each { and } for a code block, such as in an if statement or a for loop, should be placed on its own separate line, with the { and } lined up with the first character of the line above it. If the code block consists of only one line of code, continue to use the curly braces for clarity and in case additional code is added afterwards.

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

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

Conditional Compilation

Naming Convention for Header Files

Prefix the names of header files that we create with "tn" (initials of Team Nothing) followed by an underscore character. For example, tn_headerfile.h

When using conditional compilation, use the following format for a file named tn_headerfile.h:

#ifndef _TN_HEADERFILE_H_
#define _TN_HEADERFILE_H_