Current Documentation

Documentation:

ReadMe Includes:

• Brief Summary of program
• Requirements to run the program
• How to build / run the program

Comments Include:

• Summary and remarks about each “modules” and “Subs”
• Comments on what each section of the subs do
• Commented out / not used code
• XML style
  and tags
• Comments on what some certain functions / methods do
• to explain certain parameters
• tag used for showing what a function returns
• used for identifying what a property does

All of the methods, (with the expectation of the following:

• Some of the methods in the UtilityFunctions File
• Some of the methods in the Ship file
• Some of the methods in the Player file
• One of the methods in AIPlayer
• Two of the methods in AIMediumPlayer
  )

have a basic description above them, describing at minimum a summary of the method.

Contributors:

• Includes names of contributors

Summary:

The current documentation is well implemented in comments throughout the files,
using a standard and XML type tags based on where and what the comment is about.
Compared to the comments the readmes and contributors files feel a little underwhelming.
Although the readme includes a brief summary of the program, I believe a bit more about
the game could be written. Some instructions on how to play and a more fleshed out /
detailed installation instructions could be added. Finally I believe that the Contributors
could have been included in the readme and not in a separate file.