Skip to content

Comments to view classes

Nezar Dimitri requested to merge dimitn/Battleship:master into master

Hello Battleship admins,

As part of a Software Engineering Degree, I was tasked with finding a some open code that was in need for further documentation. Despite your efforts in documenting the entire planning phase as well as some of the architecture, the code was lacking some in-line comments.

I have taken it upon myself to add enough comments to 2 of your view classes BattleshipGUI.java & HitAndMissBoard.java. The reason I have chosen these 2 is that if this project were to be further developed the GUIs might changed, and having in-line comments would be highly beneficial in that maintenance process.

Please accept this pull request to help further your success with this Java based Battleship game.

Regards,

Nezar Dimitri

Merge request reports