JakeJayB / Bug-Jump-Group-Application

Bug Jump is a 2D platformer game which I was the lead programmer for, leading a group of 4 undergraduate students
0 stars 0 forks source link

Clean up code and make comments #4

Open JakeJayB opened 9 months ago

JakeJayB commented 9 months ago

This issue is focusing more on programmer flexibility rather than non-programmer flexibility. There are parts of almost all of the java project files that are in need of some explaining. If someone who had no part in implementing this game were to look at our code, they would probably have a hard time understanding what everything does. So I want to improve the code's readability for anybody who is going to look at our code.

I'd like to improve readability by doing the following :

  1. eliminating anything that isn't required for the program to work
  2. create comments in places that have a lot of complex code
  3. reduce code blocks into a more readable and concise form of themselves

Doing these three will definitely improve code readability as a whole. Improving readability overall improves programming flexibility since programmers will have a easier time reading and understanding what the code is trying to do, making it easier for them to implement something of their own