EPORTFOLIO

As a team discuss the role of comments within code and then come up with a template that others should follow for the programs they create in this course. When you come up with a final list mark it “Final List.”

1. 
   Ryan Bridglal said...
   9:46 pm - April 5th, 2009

   Originally posted: 3 Mar 09 5:26 PM MST

   ok, based on what the professor has stated, let’s get a team environment going. I’ll say, we all should post what we believe the role comments should be within a program.

   Then by wednesday, we take a vote on the rules to use.

   Thursday, someone has to tally up the votes. Someone else can add up the tally list with the most votes in a separate post.

   Friday, then let’s make a rule card (anyone ever create a quick cheat sheet or rule card for a game? that’s what I’m talking about), that expresses what we believe should be the rules to follow when writing comments in code.

   Saturday and Sunday…

   Someone else can edit and revise the card/list.

   And then we can post a final list at the end of the week.

   How does this sound to everyone? I’ll post my ideas tonight and if anyone has other suggestions, start talking/posting. I’m open for anything, it would be nice to actually have a team project this week.

2. 
   Ryan Bridglal said...
   9:46 pm - April 5th, 2009

   The instructor:

   Originally posted: Brooke Estabrook-Fishinghawk 4 Mar 09 5:11 AM MST

   Response to Ryan

   Good direction

3. 
   Ryan Bridglal said...
   9:47 pm - April 5th, 2009

   Originally Posted: 4 Mar 09 12:19 PM MST

   I’d like to vote on

   1. Comments should be at the begining of the program. To beirefly describe the project.

   2. They should also be throughout various parts of the code to explain certain statements.

   3. The length of the comment should not exceed the length of the code.

   4. It should be Informative and to the point; I myself have a bad habit of long comments in code.

   5. The comments should be comprehendable by anyone who intends on reading through your code.

4. 
   Ryan Bridglal said...
   9:47 pm - April 5th, 2009

   Originally Posted: 7 Mar 09 9:28 PM MST

   Hello, I’ll come in and post a draft of the final tonight. When everyone wakes up on Sunday morning it will be here. feel free to say if it is a final or needs revision. I’ll say, by Sunday at 5pm or 7pm we will post the final.

   I’ve been working long hours the past few days, I’ll post up my programs and the rule card draft.

5. 
   Ryan Bridglal said...
   9:48 pm - April 5th, 2009

   Originally Posted: Brooke Estabrook-Fishinghawk 8 Mar 09 4:44 AM MST

   The instructors response:

   Response to Ryan

   I am awake—get that draft in so all can review.

6. 
   Ryan Bridglal said...
   9:49 pm - April 5th, 2009

   Originally Posted: 8 Mar 09 12:42 PM MST

   OK, I did a quick run through of all the votes again and here’s the result of what will be included in the draft:

   # 1 Comments on the header of the program. #VOTES= 7
   To beirefly describe the project. Use comments to head programs with author, date, and purpose.

   # 2 Comments opening and closing classes. #VOTES= 7
   They should also be throughout various parts of the code to explain certain statments. Comment the end of each method, constructor, class, and control statement.

   # 4. Comments on complex loops. #VOTES= 6
   Comment each calculation, display, prompt, variable, and import statements.

   #5The comments should be comprehend able by anyone who intends on reading through your code.
   #VOTES= 4

   VOTES #1 to be included in draft

   Comment single lines with // and multiple lines with /* */.

   Comment to dilineate the initialization, processing, and termination phases.

   Use a common and proper naming convention such as the Hungarian Notation while writing code.

   I’m gonna get started on the draft in Word Format. will post within 1/2 hour.

7. 
   Ryan Bridglal said...
   9:49 pm - April 5th, 2009

   Originally Posted: 8 Mar 09 12:56 PM MST

   I just caught some thing, I’m going to leave this out because it’s for writing code. Not, writing comments. It is a great practice to have when writing code….

   Use a common and proper naming convention such as the Hungarian Notation while writing code.

8. 
   Ryan Bridglal said...
   9:53 pm - April 5th, 2009

   Originally Posted: 8 Mar 09 1:32 PM MST

   Here’s the draft, created with Microsoft Word. I still need to add references and i’ll come back by 5 or 6 pm in UAT’s time to check up. Let me know if I should add or remove anything.

   wk2teamproject.doc

9. 
   Ryan Bridglal said...
   9:57 pm - April 5th, 2009

   Originally Posted: 8 Mar 09 5:02 PM MST

   FINAL SUBMISSION.

   This is the final submission with references to everyone who posted and where I got the picture.

   wk2teamproject_final.doc