[CS2113-T13-4] TypingGame #36
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,96 @@ | ||
|
|
||
| # Developer Guide | ||
| * [Acknowledgements](#acknowledgements) | ||
| * [Design & Implementation](#design-&-implementation) | ||
|
|
||
| * [Acknoledgements](#acknowledgements) | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
| * https://www.baeldung.com/java-testing-system-out-println | ||
|
There was a problem hiding this comment. The link is now plain text. It should be wrapped with |
||
|
|
||
| ##Architecture | ||
|
There was a problem hiding this comment. Missing whitespace after There was a problem hiding this comment. Missing whitespace after
|
||
|
|
||
| (Some architecture diagram) | ||
|
|
||
| ## Design & implementation | ||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
|
|
||
| ### Choose game mode | ||
|
|
||
| ### Choose the game content | ||
|
|
||
| ### Word Limit Game | ||
|
There was a problem hiding this comment. Should the "Alt" be changed to "Opt" instead since you do not have the "else" block?
|
||
|
|
||
| Once the CommandFactory reads a 'word' command, a word limit game will begin. | ||
|
|
||
| Gonna to change this .puml diagram later - zhansen | ||
|
|
||
|  | ||
|
There was a problem hiding this comment. Would it be better to use vector graphics such as SVG, which displays nicely even on the dark background you choose? It would be better to just link to an online one that renders the diagram. This has the following benefits of reducing binary blobs in the repo. There was a problem hiding this comment. There should be
|
||
|
|
||
| ### Time Limit Game | ||
| Sequence Diagram for Time Mode Game: | ||
|  | ||
|
|
||
|
There was a problem hiding this comment. It is possible to position the elements such that the text is not blocked by others so it is easier to read? There was a problem hiding this comment. Similarly, are the return arrows supposed to show return values or method calls? If it is return values, the arrow should be dotted here |
||
| ### \[Proposed\] View Statistics feature | ||
|
There was a problem hiding this comment. The self-invocation of the Sequence diagram is missing the method it is calling.
|
||
| #### \[Proposed Implementation\] | ||
|
There was a problem hiding this comment. There seems to be missing dotted arrow heads back to the calling class as I circle in red in the picture attached below. Moreover, your loop and alt format is not drawn correctly, please refer to the module webpage for the details.
|
||
| The top-level logic of view statistics feature resides in ViewCommand. It implements the Command | ||
| interface. The key method of the class is `executeCommand()`. | ||
| `executeCommand()` logic: | ||
| 1. Calls the retrieveStatistics() method of StatisticsManager to get the statistics. | ||
| 2. Calls the displayStatistics() method of ViewCommandUi to display the statistics retrieved. | ||
| <!-- --> | ||
| StatisticsManager performs the logic for processing the game records to obtain the statistics. | ||
| Its key methods are: | ||
| * `retrieveStatistics()` - Decides which of the three methods below to run | ||
| * `calculateBestStatistics()` - Returns the best statistics over the past n games | ||
| * `calculateWorstStatistics()` - Returns the worst statistics over the past n games | ||
| * `calculateAverageStatistics()` - Returns the average statistics over the past n games | ||
| <!-- --> | ||
| Given below is an example usage scenario and how the program implements the feature. | ||
|
|
||
| Step 1: The user launches the application (scenario assumes that there are several game records already stored in multiple files). | ||
|
|
||
| Step 2: The user executes `view -m best -g time -n 9` to view his/her best statistics for the error game mode over the past 9 games. | ||
|
|
||
| Step 3: A ViewCommand object is then instantiated. | ||
|
|
||
|  | ||
|
|
||
| Step 4. ViewCommand calls the retrieveStatistics() method of StatisticsManager. | ||
|  | ||
|
|
||
| Step 5: StatisticsManager creates a GameRecordsManager object. | ||
| * The constructor of GameRecordsManager calls the readGameRecords() method of the Storage class to retrieve the gamer's past game records from the text files. | ||
| <!-- --> | ||
|  | ||
| Step 6. StatisticsManager then calls getGamesRecords() method of GameRecordsManager() and self-invokes calculateBestStatistics(). | ||
| * Calculated statistics is returned. | ||
|
|
||
| Step 7. ViewCommand calls the displayStatistics() method of the ViewCommandUi class to display the statistics. | ||
|  | ||
|
|
||
|
There was a problem hiding this comment.
|
||
|
|
||
| The following sequence diagram shows how the above scenario is executed. | ||
|  | ||
|
There was a problem hiding this comment.
There was a problem hiding this comment. When calling a constructor, there is no need to put the "new". Moreover you should use the same sequence diagram drawing tool as stated in the module page (attached below).
|
||
|
|
||
|
|
||
|
|
||
| #### Alternative Implementation | ||
| * One implementation considered is to do away with the retrieveStatistics() method and immediately call one of calculateBestStatistics, | ||
| calculateWorstStatistics() or calculateAverageStatistics() based on the gamer's imput using a switch statement. This implementation choice | ||
| was not used because it violates the Single Responsibility Principle and does not do SLAP well. | ||
| * Another implementation considered was for GameRecordsManager to do the main logic. This implementation was not done as it violates the | ||
| Single Responsibility Principle. | ||
| <!-- --> | ||
|
|
||
| ## Product scope | ||
|
|
||
| Our product is a typing game, intent to provide enjoyment for people who are familiar with the CML. | ||
|
|
||
|
|
||
| ### Target user profile | ||
|
|
||
| {Describe the target user profile} | ||
|
|
@@ -28,6 +109,8 @@ | |
| ## Non-Functional Requirements | ||
|
|
||
| {Give non-functional requirements} | ||
| ### Animation | ||
|
|
||
|
|
||
| ## Glossary | ||
|
|
||
|
|
@@ -36,3 +119,4 @@ | |
| ## Instructions for manual testing | ||
|
|
||
| {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing} | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| theme: jekyll-theme-hacker |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Lim Jia Jing - Project Portfolio Page | ||
|
|
||
| ## Overview | ||
|
|
||
|
|
||
| ### Summary of Contributions |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Lu Sicheng - Project Portfolio Page | ||
|
|
||
| ## Overview | ||
|
|
||
|
|
||
| ### Summary of Contributions |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The sections should be numbered and the table of content should be included.