Investigate documented code and Reporting(Lim) - LimYewKwong/BattleShip GitHub Wiki

AIPlayer.cs & AttackResult.cs & BattleShipsGame.cs & ISeaGrid.cs & Player.cs & SeaGrid.cs & Title.cs &

-The comments are the summary of the classes. It describes how the classes work or what the classes implement.

-There are some comments describes about the parameter. It has written some detail of the parameter value, in each class that contains parameters.

-Some are comment about what are the values of getter and setter.

-The comments is also written about what is the return value of the class when it meets different condition.

AIHardPlayer.cs & AIMediumPlayer.cs & SeaGridAdapter.cs & Ship.cs &

-The comments are the summary of the classes. It describes how the classes work or what the classes implement.

-There are also some comments describes about the parameter. It is written about the value of the parameter in each class.

-Some comments is to show what is the return value of the classes.

AIOption.cs & Direction.cs & ResultOfAttack.cs & ShipName.cs & TitleView.cs

-The comments are only the summaries of the classes. It describes how the classes work or what the classes implement.

EndingGameController.cs

-The comment of EndingGameController.cs is to describe how the classes work, and the implementation.

GameController.cs

-Documented code of GameController.cs describes the summaries of classes, which tells us how the what do the classes do. -It also tells what are the value from getter and return value of setter. -Remarking what does specific code implementing at. -Understand the value of parameters in some class.