Wk04: Learning Journal Project 1 review

 

1. You can work with up to three people (you MUST work with at least one other person)

1. With whom did you work?

I worked with Jael Roman to complete this Project 1 review. During the process of completing the Project 1 assignment I worked in a cafe with Sylvia Wang with me. We didn’t work together on our assignment, we were just in each other's company, working on what we had to complete for the previous module. For me on that day I worked on Project 1.

2. What was your strategy for solving the assignments?

My initial step was to read the prompt carefully, multiple times. Once I understood the prompt I broke it down into individual sections such as readFile, selectWord, guessLetter, and getHint. My next step was to develop each section individually and run unit tests frequently to determine which ones were passing and failing. Once a test failed, I reviewed the error message along with the Javadoc to identify what behavior was missing or incorrect.

1. Did you start writing code right away? Did you plan it out on paper? 

I completed a little bit of both. I did not begin coding immediately. First, I quickly outlined the primary areas of the assignment and created a simple flow chart to illustrate what each section of the code was responsible for. Then I began creating the basic framework of the class and proceeded to add detail to it. I did not create an overly detailed paper design, I simply had a general plan before I typed.

3. What was THEIR strategy for solving the assignments

Jael Strategy was, “My strategy for solving the project assignment goes as follows: First, I read the prompt from start to finish without typing or writing anything down, I let the knowledge absorb in my heart and spend a minute or two to try to fully understand the project goal and material. Secondly, I write down quick notes on my iPad on the structure of my program. Third, I start typing out the fields and methods first, then getters and setters. Fourth, I implement the logic and proceed with further clarification and make any edits. Fifth, once I am done with the basic logic, I start my tests and proceed with any debugging procedures to fix any errors or syntax. Finally, I make adjustments as needed. Oftentimes, most of my tests end up failing, so if that happens after implementing the logic, I fix every test in order.”

4. How would you change your strategy having worked on the assignment?

In the future I would take the time to ensure that my printed messages and Javadoc match the specifications provided prior to initiating testing. Additionally, I would review the unit tests prior to testing so that I am aware of the expectations of the unit tests versus discovering minor wording discrepancies during testing. Overall, I would continue to write my code in small sections, but I would focus on details such as messages and edge cases throughout the development process.

5. According to your classmate(s): how well does your code follow the Google Java Style Guide

Per Jael, “Sharmaine’s overall structure is good and readable however some adjustments could be made to further improve her code. The top issue would be indentation. I noticed some blocks uses four spaces instead of two (near calculateDefensePoints). Another tips would be spacing issues, where a missing space before opening braces around line 270. Last tip would be Javadoc inconsistencies where there are summary lines and vague @return descriptions (near lines 140 getAttackMin and line 300 calculateAttackPoints). Small tweaks around indentation and spaces would improve Sharmaine’s format to adhere to Google’s Style Guide.”

1. Did you know you can automate applying some of the style guide?

Yes, I am aware of several ways that tools, including IntelliJ, may provide assistance in automating some of the rules contained within the Google Java Style Guide, specifically with respect to formatting, indentation, spacing, and brace placement. It is my intention to utilize these tools to prevent manually correcting each of the style issues that arise.

 

6. What was the most challenging part?

For me the most difficult part of this project was ensuring that the edge cases and wording were correct. Issues such as how getHint() would behave when most of the letters in the word had been guessed and how the messages would need to match the unit tests more closely than the logic itself consumed much of my time. Ensuring that my code, my Javadoc, and the unit tests agreed was the most difficult task for me.

7. What was the most interesting?

The most interesting part was seeing how Jael solved the same problem in slightly different ways. We had similar logic, but we made different choices about messages, checks, and edge cases. Reading her code helped me see other styles and tricks I wouldn’t have thought of on my own.

8. What are you the most proud of?

I am proud that I’m able to understand and complete these assignments and projects, even though it takes me longer than someone who may already know Java. It’s a little embarrassing to admit, but I work on my assignments at work during work and on my lunch, then after work, and after making dinner I’m back at the computer again from around 8 PM to 12 AM or even 1–2 AM. Even though it’s a lot, I’m genuinely thankful to Dr. C for the amazing instruction videos and lectures, which make the concepts feel more approachable. I’m also really grateful for our TA, who is OUTSTANDING, she’s incredibly responsive and very helpful, and she doesn’t let up until the problem is actually fixed. I am also very grateful for my group. They have been an amazing support, I couldn’t do it without you all.

9. How did you celebrate completing the assignment? 

1. If you didn't how will you celebrate?

1. This isn't a joke. It helps our learning to celebrate and acknowledge victories.  <-- Dr.C just fought for your right to party.

I haven’t celebrated yet, but I intend to... possibly once the class is finished. I think I still need to learn more before I consider taking a break, therefore I continue to be on the computer from early morning to almost late night again. Once I’m done, I’d like to take a break, watch some shows on Netflix, go on a hike, visit my grandmother, and perhaps get something to eat with my daughter.