[CS2113T-W11-1] MoneyGoWhere #1
Conversation
docs/DeveloperGuide.md
Outdated
| ## Acknowledgements | ||
| ## Introduction | ||
|
|
||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
| {add introduction here} | ||
|
|
||
| ## Design & implementation | ||
| ## Acknowledgements | ||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} |
There was a problem hiding this comment.
Would it be better if you remove the lines with { } for your final DG?
docs/DeveloperGuide.md
Outdated
| ### Software Architecture: | ||
| The software architecture diagram below describes the application's design and the interaction between components. | ||
|
|
||
|  |
There was a problem hiding this comment.
Your software architecture diagram looks clear and easy to understand!
docs/DeveloperGuide.md
Outdated
| In this example, | ||
| the user enters the command `Add-Expense -n Expense -a 7.80` to add an expense with the name `Expense` and the amount `7.80`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Should the following method call be directed at the start of a new activation bar?
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Common Component | ||
|
|
||
|  |
There was a problem hiding this comment.
This diagram appears to be missing
Relevant screenshot:
docs/DeveloperGuide.md
Outdated
| ### Software Architecture: | ||
| The software architecture diagram below describes the application's design and the interaction between components. | ||
|
|
||
|  |
There was a problem hiding this comment.
Good job on the clear and accurate architecture diagram!
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Common Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Unable to understand Common Component diagram
docs/DeveloperGuide.md
Outdated
| In this example, | ||
| the user enters the command `Add-Expense -n Expense -a 7.80` to add an expense with the name `Expense` and the amount `7.80`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Perhaps consider placing the Add-Expense method call at the very start of the activation bar?
docs/DeveloperGuide.md
Outdated
| In this example, | ||
| the user enters the command `Add-Expense -n Expense -a 7.80` to add an expense with the name `Expense` and the amount `7.80`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Perhaps a new object needs to be created for consoleCommand? Assuming consoleCommand is not a method under UserInterface
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Exceptions Component | ||
|
|
||
|  |
There was a problem hiding this comment.
More textual explanations to accompany the diagrams would be useful
docs/DeveloperGuide.md
Outdated
| * `UserInterface#getConsoleCommand()` calls `UserInterface#getConsoleInput()` to read the user's input as a string. | ||
| * `UserInterface#getConsoleCommand()` then calls `Parser#parse()` to parse the input string into the corresponding console command object. | ||
|
|
||
|  |
There was a problem hiding this comment.
Is this image needed? Please kindly remove it if not needed.
docs/DeveloperGuide.md
Outdated
|
|
||
| The Common component consists of the class `Messages` and `Configurations`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Please kindly insert the diagram for this part as it is not visible in DG.
|
|
||
| ### Commands Component |
There was a problem hiding this comment.
Good job on the usage plantUML for the diagrams! Very clean and detailed!
docs/DeveloperGuide.md
Outdated
| * `UserInterface#getConsoleCommand()` calls `UserInterface#getConsoleInput()` to read the user's input as a string. | ||
| * `UserInterface#getConsoleCommand()` then calls `Parser#parse()` to parse the input string into the corresponding console command object. | ||
|
|
||
|  |
There was a problem hiding this comment.
This image reflected may not be intended for this section, do consider the image that has been added.
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Exceptions Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Consider spacing out the arrowheads to the MoneyGoWhereException
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Commands Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Consider adding more details to the User Interface Component, looks like it does not explain much.
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Adding an expense from a recurring payment: `Pay-RecurringPayment` | ||
|
|
||
|  |
There was a problem hiding this comment.
Consider reviewing your [Implementation-Edit-RecurringPayment], looks like the image cannot be seen
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Adding an expense: `Add-Expense` | ||
|
|
||
|  |
There was a problem hiding this comment.
Consider reviewing your[Implementation-Add-Expense] looks like the image cannot be seen
docs/DeveloperGuide.md
Outdated
| ## Implementation | ||
| ### Reading and parsing the user's commands | ||
|
|
||
|  |
There was a problem hiding this comment.
Consider omitting <> on the sequence diagram as it may not be accounting to convention
docs/DeveloperGuide.md
Outdated
| the user launches the program and enters the command `Add-Expense -n Expense -a 7.80` to add an expense with the name `Expense` and the amount `7.80`. | ||
| The sequence diagrams referenced by the component interaction diagram can be seen [below](#component-interaction-sequence-diagrams) | ||
|
|
||
|  |
There was a problem hiding this comment.
Should this instance of MoneyGoWhere be created by the user instead?
docs/DeveloperGuide.md
Outdated
| ## Implementation | ||
| ### Reading and parsing the user's commands | ||
|
|
||
|  |
There was a problem hiding this comment.
Are the consoleCommand calls necessary?
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Adding an expense: `Add-Expense` | ||
|
|
||
|  |
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Viewing an expense: `View-Expense` | ||
|
|
||
|  |
There was a problem hiding this comment.
Is the format used for the conditions in the alt and opt paths the best in terms of readability? Perhaps it should be explained in words rather than code?
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Printing a recurring payment | ||
|
|
||
|  |
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Adding a recurring payment: `Add-RecurringPayment` | ||
|
|
||
|  |
There was a problem hiding this comment.
Is this instance of recurringPayment still used in the future? Should it be deleted?
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Exceptions Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Perhaps MoneyGoWhereException class should be labelled as an abstract class?
…files Updating Rounding up
Fix typo in developer guide
Update portfolio page
Updated portfolio
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Common Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Should this diagram have more explanations? It is difficult to see how it is relevant to the reader.
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Commands Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Is this diagram overly complicated? Should it be less complex so that the reader can see the main point of the diagram?
docs/DeveloperGuide.md
Outdated
|
|
||
| ### UserInterface Component | ||
|
|
||
|  |
There was a problem hiding this comment.
Is this diagram useful to the reader? How informational is it to the reader? Would it be better if there is some explanation/more information as to what happens in Parser/Data/Logger?
docs/DeveloperGuide.md
Outdated
| In this example, | ||
| the user enters the command `Add-Expense -n Expense -a 7.80` to add an expense with the name `Expense` and the amount `7.80`. | ||
|
|
||
|  |
There was a problem hiding this comment.
Good work on this sequence diagram, look foward to seeing more sequence diagrams in your Developer Guide!
…pense and edit-expense
Fixed numberformatexception for indexes for income and targets
Update Diagram for Sort-Expense in DG
Update User Guide
Update project webpage
Update portfolio links in about us
MoneyGoWhere is a financial planner to help you manage your finances.