Changes

Jump to: navigation, search

OOP344 ASOS

4,708 bytes added, 00:12, 11 November 2009
no edit summary
== ASOS Brigade ==
 
Normal 0 false false false false EN-US X-NONE X-NONE MicrosoftInternetExplorer4 === Project Overview ===
== Project Description ==
 
The purpose of this project is to build a working command line text editor. It will be built from the ground up with an open source mentality using C/C++. We will be using an SVN repository in order to keep all of our files updated and organized, and to keep overwriting errors to a minimum. Our wiki page will also spell out our direction and any other information needed.
 
1.2 Class Overview
 
 
2.0 Participants
 
2.1 Group Contacts Chi-Lea Tran
 
Username: ctran13
 
Section: C
 
Blog: http://ctran13.blogspot.com/
 
Email: ctran13@learn.senecac.on.ca
 
Wen Fang Chen
 
Username: wfchen
 
Section: C
 
Blog: http://wenfangchen.blogspot.com/
 
Email: wfchen@learn.senecac.on.ca
 
2.2 Group Members
 
Wen Fang Chen
 
IRC Username: Gwen2009
 
Section: C
 
Blog: http://wenfangchen.blogspot.com/
 
Email: wfchen@learn.senecac.on.ca
 
Yong Hong
 
IRC Username: Yong_Clicker
 
Section: B
 
Blog: http://xderick.blogspot.com/
 
Email: rod1205@hotmail.com
 
Taehoon Kim
 
IRC Username: hoongoon
 
Section: B
 
Blog: http://hoonkoon.blogspot.com/
 
Email: hoongoon86@hotmail.com
 
Chi-Lea Tran
 
IRC Username: ctran13
 
Section: C
 
Blog: http://ctran13.blogspot.com/
 
Email: ctran13@learn.senecac.on.ca
 
Victor Tran
 
IRC Username: victran
 
Section: C
 
Blog: http://victran.blogspot.com/
 
Email: victor.vy.tran@gmail.com
 
 
Cong Wang
 
IRC Username: cwang84
 
Section: B
 
Blog: http://wangcong422.blogspot.com/
 
Email: cwang84@learn.senecac.on.ca
 
Shun Yao Zhang
 
IRC Username: DownWind
 
Section: C
 
Blog: http://shunyao-cpa.blogspot.com/
 
Email: syzhang4@learn.senecac.on.ca
 
Yong Xue
 
IRC Username: yxue11
 
Section: C
 
Blog: http://opp344-yxue.blogspot.com/
 
Email: yxue11@learn.senecac.on.ca
 
 
3.0 SVN Repository
 
3.1 Address svn://zenit.senecac.on.ca/ops344_093a06 3.2 Usernames and Logins
 
4.0 Conventions and Styles
 
4.1 File headings
 
 
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 */. For example:
 
 
/*
 
File Name: example.cpp
 
Author: Victor Tran (victran)
 
Date: 27-Oct-09
 
Description: blah blah blah
 
*/
 
4.2 Function Comments
 
 
Each function should include a comment above the function similar to the file heading (4.1), except only including the function name and a description of what the function does. For example:
 
 
/*
 
Function Name: FunctionName
 
Description: Blah blah blah.
 
*/
 
int FunctionName()
 
{
 
code;
 
}
 
4.3 Inline Comments
 
 
Inline comments should be used to clarify what exactly something is doing, or to leave a note for yourself or others regarding the code in that general area. Please use inline comments wherever the code might be confusing for others to understand.
 
4.4 Indent level
 
 
All documents must have indentation when writing code in a code block. The indent level in any case will consist of two spaces. There will be no tab use. For example:
 
 
int someFunction
 
{
 
code;
 
more code;
 
}
 
 
4.5 Curly Bracket Use
 
 
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. For example:
 
 
if ( mapleLeafs == lose)
 
{
 
fans->getAngry();
 
}
 
4.6 Variable Naming Conventions
 
 
Variables should follow regular programming conventions ( must start with lowercase letter, no symbols…). Variables should be descriptive for better understanding of it’s For example:
 
 
int someVar;
 
4.7 Function Naming Conventions
 
 
Function names should start with a capital letter. For example:
 
 
int SomeFunction()
 
{
 
code;
 
}
SVN: ops344_093a06
{| border="1" cellpadding="5"
1
edit

Navigation menu