Combat Items: SonarCloud - UQdeco2800/2022-studio-2 GitHub Wiki

Back to Combat Items Contents Page

Sonar Cloud Errors

When reading through SonarCloud for bugs and errors within the code, while there were no bugs related to our team's code there were various 'code smells' alerts within our code. A common reoccurring minor error was unused imports throughout the code. Additionally, a major 'code smells' alert in the WeaponsFactory and AuraFactory was a significant amount of commented code. While certain aspects have been resolved, there are some 'code smells' alerts that need to be reviewed with the code authors and team.

Solutions Fixed

  • All unnecessary imports, minor code smells
  • auraToApply private variable removed from classes within the directory CombatItemsComponent, major code smells
  • All unused commented code removed from AuraFactory and WeaponsFactory, major code smells

To Be Reviewed

Major

  • Hash map implementation for all classes under CombatItemsComponent directory needs to change to another map interface

Example:

  • Make a private constructor in WeaponsFactory and AuraFactory. Discussion with other coders to ensure this is done properly without breaking code
  • WeaponsStatsComponent review purpose of logger with authoring coder to be removed from file
  • Change constructor visibility to protected in WeaponsStatsComponent class

Minor

  • Convert variables in all Combat config files to static final constant
  • Package names don't follow standard naming protocol - all files

Example:

Back to Combat Items Contents Page

Author:

  • Madi Feddema
  • GitHub: @madifeddema
  • Discord: madi-feddema#3384
  • Slack: Madi Feddema