Documentation of the project - ThindAmrit17/Battleship GitHub Wiki

I went through all the source file to find how well they all are documented. I first examine all the files are src/models. This class under model folder is well documented. All the files in model folder have summary on the top which describe the function of each file being used and also these files have inline comments and summary which tell the programmer about the functioning of each code being written or used in a specific file. Thus, it make a way easier for anyone to understand the functioning of each file easily.

However, there are three files under src folder which completely lack or did not documented properly.

1. The first file is GameLogic.vb . This file do not have any summary on the top or any inline comments which make harder for anyone to describe the functioning of this file.
2. Similarly, GameResources file is the only file which hardly have any documentation. The file have no summary on the start of the file, no inline comments and even the functions or parameters within the file do not have any summary. Thus, the person have to go through the whole document within the file to understand the functioning of the class and also what is functioning of the specific code or function.
3. Lastly, the UtilityFunctions file have summary on the top and even inline comments in the first part of the file but the middle part of the file completely lacks any summary or inline comments. Thus, the second half of the file do not have any information regarding the functioning of each part within the file.

In crux, all the files in battleship project are completely maintained except for these three files. the three files that are not documented properly, the team will document them properly after the conversion of project files from .vb to C#.