Original Documentation - Paves22/battleships GitHub Wiki

Overall the code base is documented very well as nearly every block of code has a summary of what it does, then a detailed description of parameters, values and what is returned where it is applicable. While this documentation is quite consistent throughout the entire code base there are some exceptions where, it seems, the coder has forgotten to finish making these comments on a file.

In the GameResources.vb file there is some blocks of code that could use some documentation to explain exactly what the code is doing or at least what it relates to. This is extremely apparent from line 198 where there isn’t another comment for the rest of the file which is 272 lines long. This happens again in UtilityFunctions.vb from line 214 where the file is 271 lines.