Comment On Your Code!

-

 In the last week of our group project, while immersed in code cleanup and finalizing our Post-Mortem presentation, a notable challenge arose related to the absence of a standardized commenting style within our codebase. The lack of consistency in commenting practices made it challenging for team members to grasp the intricacies of different sections of code, leading to confusion and a slowdown in our progress. The issue of poor commenting not only hindered immediate collaboration but also posed potential challenges for future maintenance and scalability.

To address the problem of inconsistent commenting, our team opted for a pragmatic solution. We initiated a discussion to collaboratively define a simple yet effective commenting style that everyone could adopt. This involved agreeing on conventions for documenting functions, explaining complex logic, and providing context for important decisions. While we didn't enforce an overly rigid style, the goal was to establish a set of guidelines that promoted clarity and consistency. In addition, we organized brief training sessions to ensure that all team members were familiar with the agreed-upon commenting practices. This solution not only improved the understandability of our codebase but also encouraged a more unified approach to documentation during the critical final week of the project.



Author: Zachary Giffin

Posted: 12/08/2023

Comments

Post a Comment

Popular posts from this blog

Resolving the Flying AI Bug: Boundary Fix in Level One Environment

-
Image
  While the initial testing of AI units showed promise, an unexpected issue surfaced when we integrated the flying AI into the official level one environment. An unusual bug emerged, where the upper bounds of the flying AI were being disregarded when placed in an elevated location within the terrain of level one. This, in turn, hindered the unit from carrying out its essential functions and completely disrupted player interactions.   Through a series of thorough AI tests, we pinpointed the root of the problem to be the assignment of the lower bounds, which was inadvertently causing the upper bounds of the AI to extend far beyond their intended limits. This anomaly led to the flying unit soaring high above the level, out of the player's reach.   To address this issue, we made a strategic adjustment by assigning the lower bounds before implementing the Z Offset and setting it to the initial position of the AI's mesh, firmly grounded on the level's floor. This modifica...
Read more

Paying attention to Details

-
 As I have worked on the project and added my contributions, I tend to often make small mistakes that I don't see right off the bat. An example of this would be in this week when I had pushed my code to Perforce and I had not saved the content I had worked on within the .h. This push caused issues for everyone when they pulled and realized that things were broken. I tend to get so caught up in my work and the absolute rush of getting something right can leave room for mistakes. A fix for this problem is to look back on my time in the military and ensure that I am paying attention to  detail. Whether it is a variable I have forgotten to create or I just hadn't saved an entire file of my project.  It is important to take time to make sure what I am submitting is not just done quickly, but also efficiently  with the proper quality in order to ensure my team is not lost on what I am doing. From now on, I will be  more cautious on my work and double checking what I a...
Read more

Revamping the player's attacks

-
 I have begun looking into adding the multi attack feature for our game. We originally had it set where the attacks were all placed in an animation slot to play them while they were in an array. This unfortunately does not work too well with attack animations due to the attacks constantly cancelling out. This has forced me into finding new and better ways to implement a multi attack in order to fluently and properly function within the game.  In order to fix this, I plan on revamping the entirety of the attack animations including the functions I  currently have set up for the attack to hopefully get the outcome I am aiming for. Within this, I want to  start with a bool that is checking whether the player is already attacking. Once this bool is false, it will  begin the incrementing of the attacks. I then will add an if statement checking if the combo has reached  the maximum amount of attacks within the combo, in which I will have a function to reset the c...
Read more