Difference between revisions of "OOP344 Temporary"
NorthWind87 (talk | contribs) (→OOP344 northWind87: Added coding standards section, more to do soon...) |
NorthWind87 (talk | contribs) (→OOP344 northWind87: Added some more stuff to coding standards, about two-thirds of the way there...) |
||
Line 22: | Line 22: | ||
== Coding Standards == | == Coding Standards == | ||
− | === Naming | + | === Naming Conventions === |
− | * Camel | + | * ''' Camel Notation ''' should be used for variable names and function names |
− | * Class names should always be | + | ** ''' ie ''' myVar, bigInt, getNumber(), myFunction() |
− | * Compiler directives should always be written in | + | * Class names should always be ''' First-Letter Capitalized ''' |
− | * Compiler definitions should be | + | ** ''' ie ''' TestClass, DynamicStack, PeanutButter, Hammer |
− | * Header file defines should be preceeded and followed with | + | * Compiler directives should always be written in ''' All Lowercase ''' |
+ | ** ''' ie ''' #define, #ifndef | ||
+ | * Compiler definitions should be ''' All Uppercase ''' and should only use underscore where a gap is required | ||
+ | ** ''' ie ''' IO_CTL_LARGEFILE, SOME_DEFINITION | ||
+ | * Header file defines should be preceeded and followed with ''' Two Underscores ''' | ||
+ | ** ''' ie ''' __CIOL_H__, __IO_FORM_H__ | ||
+ | * Finally, <code>void</code> should always be explicitly declared. | ||
+ | ** ''' ie ''' void doStuff(void), int getInt(void) | ||
+ | |||
+ | === Statement Notation === | ||
+ | The first left parenthesis on a function declaration should open immediately after the function name while the first left parenthesis on a loop declaration should open one space after the loop declaration.<br /> | ||
+ | ''' ie Functions: ''' | ||
+ | <pre> | ||
+ | int hello( | ||
+ | char goodbye( | ||
+ | void getQuestion(</pre> | ||
+ | |||
+ | ''' ie Loops: ''' | ||
+ | <pre> | ||
+ | while ( | ||
+ | for ( | ||
+ | do (</pre> | ||
=== Code Blocks === | === Code Blocks === | ||
− | . | + | Both function blocks and loop blocks should open on the same line as the declaration statement preceeding them; however, function blocks should open immediately after the last right parenthesis while loop blocks should open one space after the last right parenthesis.<br /> |
+ | ''' ie Functions: ''' | ||
+ | <pre> | ||
+ | int hello(){ | ||
+ | char goodbye(){ | ||
+ | void getQuestion(void){</pre> | ||
+ | |||
+ | ''' ie Loops: ''' | ||
+ | <pre> | ||
+ | while (var < 15) { | ||
+ | for (int i = 0; i < 15; i++) { | ||
+ | do (blah) {</pre> | ||
== Announcements == | == Announcements == |
Revision as of 23:20, 27 October 2009
OOP344 - OOP344 Student List - OOP344 Teams - OOP344 Assignment One - OOP344 Assignment Two
Contents
Team Temporary Name
Group Contact/Team Leader: Hasan
Group Contact #2: Joseph Hughes
Last Name | Name | Seneca Username | Section | Blog Url | IRC Nick | Current Task | SVN Username |
---|---|---|---|---|---|---|---|
Butnaru | Stefan | sbutnaru | B | Blog | Fonzie | - | ops344_093svn114 |
Hughes | Joseph | jphughes | B | Cloudscorpion's Blog | CloudScorpion | - | ops344_093svn112 |
Johnson | Ausley | aljohnson1 | B | My Blog | Ausley_Johnson | - | ops344_093svn113 |
Kamal-Al-Deen | Hasan | hkamal-al-deen | B | The Orbital Station | northWind87 | - | ops344_093svn111 |
Sandhu | Charanjit | cssandhu | B | Blog | Charanjit | - | ops344_093svn114 |
Coding Standards
Naming Conventions
- Camel Notation should be used for variable names and function names
- ie myVar, bigInt, getNumber(), myFunction()
- Class names should always be First-Letter Capitalized
- ie TestClass, DynamicStack, PeanutButter, Hammer
- Compiler directives should always be written in All Lowercase
- ie #define, #ifndef
- Compiler definitions should be All Uppercase and should only use underscore where a gap is required
- ie IO_CTL_LARGEFILE, SOME_DEFINITION
- Header file defines should be preceeded and followed with Two Underscores
- ie __CIOL_H__, __IO_FORM_H__
- Finally,
void
should always be explicitly declared.- ie void doStuff(void), int getInt(void)
Statement Notation
The first left parenthesis on a function declaration should open immediately after the function name while the first left parenthesis on a loop declaration should open one space after the loop declaration.
ie Functions:
int hello( char goodbye( void getQuestion(
ie Loops:
while ( for ( do (
Code Blocks
Both function blocks and loop blocks should open on the same line as the declaration statement preceeding them; however, function blocks should open immediately after the last right parenthesis while loop blocks should open one space after the last right parenthesis.
ie Functions:
int hello(){ char goodbye(){ void getQuestion(void){
ie Loops:
while (var < 15) { for (int i = 0; i < 15; i++) { do (blah) {
Announcements
October 25, 2009
As I've emailed you all, Fardad wants two IRC meetings with us during the study week so please indicate your availability (all of it, all times that you are available) during the study week here.
Aside from that, you may also notice the "meetings" section. This will be updated as we need to meet again. Hope to hear from you all soon. -northWind87
Study Week Availability
Hasan: Tuesday 11am - 2pm, Wednesday 11am - 6pm, Thursday 6:30pm - 10pm, Friday 6:30pm - 10pm, Saturday 11am - 9pm
Meetings
Tuesday October 27
Alright guys, first meeting ever. The tentative meeting time is so far somewhere in between the afternoon (ie 1 pm) and the evening (ie 5:30 pm) so your input would be highly appreciated.
Update: Seems like everyone is OK with Tuesday at 5:30 so that is when we will meet; please go to the TEL building first floor, we will meet there. Feel free to call me at 4169097925. We will also be deciding on when to speak with Fardad during the week, come ready to choose SOMETHING .
-northWind87
Agenda:
- Design the general structure of the text editor and come to grips with what the assignment entails.
- Discuss SVN use.
- Declare all coding standards that we will need to follow so that our code doesn't look funny when it's put together :)
- Assign sections and week by week requirements.
- Decide on meeting times with Fardad.
Recommended Reading:
- SVN manual (cuz it's just so pretty!)
- Most of Assignment Two (I HIGHLY recommend doing this one)
That's all folks, please set this page and the OOP344_Assignment_Two page to be watched by wiki for you so that you're alerted of any changes. Please email me your input on the meeting time or anything else really.
As well, we're gonna have to speak to Fardad on IRC at some point although he hasn't been on IRC and hasn't emailed me about it yet so I'll let you all know once I know more. -northWind87