[CS2113-W12-3] FinText #7
Conversation
|
should be {abstract} instead of {{abstract}} |
|
|
docs/images/cs2113-storage-class.png
Outdated
There was a problem hiding this comment.
Is this too complicated? Might there be a way to display the top half better?
docs/images/ExpenseClassDiagram.png
Outdated
There was a problem hiding this comment.
Could Transaction possibly be complicated/harder to read?
docs/DeveloperGuide.md
Outdated
| All error handling is handled here and any errors/output would be passed to the `UI` component for printing and | ||
| formatting of the output. | ||
|
|
||
| | Command | Purpose | |
There was a problem hiding this comment.
Clear summary for command components! Perhaps some sample inputs could be shown to demonstrate usage?
docs/images/IncomeClassDiagram.png
Outdated
There was a problem hiding this comment.
Might there be a more intuitive/clearer manner of emphasising the goal, and displaying transaction?
docs/DeveloperGuide.md
Outdated
| ### Architecture | ||
|
|
||
| The bulk of the app's work is done by the following three components: | ||
| - `UI`: The UI of the App. | ||
| - `Parser`: Formats the user's input | ||
| - `Command`: Command's logic and execution | ||
| - `Storage`: Storage of data of the App | ||
|
|
||
|  |
There was a problem hiding this comment.
Very clear illustration of the project architecture!
| ### Storage component | ||
| The `Storage` functionality is to load data from the storage files (`category-store.csv` , `expense-store.csv`, `goal-store.csv`, `income-store.csv`) into the application. It will also stores any data while the application is running. | ||
|
|
||
|  |
There was a problem hiding this comment.
The line drawn from CsvReader to OpenCSV should be straight preferrably.
| ### Target user profile | ||
|
|
||
| {Describe the target user profile} | ||
| Users who prefer a CLI interface over a GUI and want to better manage their finances to gauge their financial health. |
There was a problem hiding this comment.
Perhaps can identify a more specific target group, e.g. SOC students.
docs/DeveloperGuide.md
Outdated
| | HelpCommand | Gives usage format information to the user | | ||
| | ListCommand | Lists all incoming/outgoing transactions | | ||
| | ExportCommand | Exports transactions data into CSV FIle. | | ||
| | RemoveTransactionCommand | Deletes a transaction | |
There was a problem hiding this comment.
Perhaps DeleteCommand is a better name since it is more concise and suits the purpose.
|
|
||
| ### UI component | ||
|
|
||
|  |
There was a problem hiding this comment.
Sequence diagram gave a very clear overview of how the 4 main components interact with each other
docs/DeveloperGuide.md
Outdated
| ## Implementation | ||
|
|
|  | ||
|
|
There was a problem hiding this comment.
Good use of class diagram to show association with openCSV
| ### Command component | ||
|
|
|
|
||
| ":UI" -> User: Gets user input | ||
| activate "User" #FFBBBB | ||
| User --> ":UI": "userInput: String" |
There was a problem hiding this comment.
Maybe you can remove the quotation marks around userInput: String and for other instances in your seq diagram
| + printGreeting(): String | ||
| + printBye(): String | ||
| + readUserInput(): String | ||
| + close(): void |
There was a problem hiding this comment.
You might want to keep your diagrams simple and omit unimportant and private members
docs/diagrams/ui-class-diagram.puml
Outdated
| } | ||
| } | ||
|
|
||
| Ui --> "{{abstract}}\nOutputStream" :> uses |
There was a problem hiding this comment.
You might want to add the multiplicity of association to outputStream and Scanner (should 1?)
| activate ":Parser" #FFBBBB | ||
| ":Parser" --> ":Main": "p: Parser" | ||
|
|
||
| ":Main" -> ":Parser": p.parse(userInput: String) |
There was a problem hiding this comment.
You might want to break down your complicated diagram here into subdiagrams. This can be done using ref frames
| @@ -0,0 +1,17 @@ | |||
| package seedu.duke.classes; | |||
|
|
|||
| public class Category { | |||
There was a problem hiding this comment.
- Maybe can use an enum for this? Similar to recurrence.
|
May use enumration for category. |
|
|
docs/images/ParserSequence.png
Outdated
docs/images/cs2113-storage-class.png
Outdated
There was a problem hiding this comment.
Perhaps consider removing the private static Strings to improve readability.
docs/images/IncomeClassDiagram.png
Outdated
There was a problem hiding this comment.
Perhaps you meant to write (hasGeneratedNextRecurrence:boolean)?
docs/images/cs2113-storage-class.png
Outdated
There was a problem hiding this comment.
I really like the way this is presented. The use of comment and folder really helps the reader visualize the operations behind the class.
Change file location for storage files
Use streams to process recurrent transactions
Fix parsing of non-negative doubles
Fix UI diagram issues
Tweak double parsing behaviour
Edit message for SummaryCommand
Update DeveloperGuide.md
Update javadocs
Update PPP
Update UserGuide and change Goal message
Add JavaDocs for test directory
Update DG on user stories
Update UserGuide and PPP
Update edit transaction
…edit Revert "Update edit transaction"
FinText is a personal finance tracker to make it easy for users to track and manage their spending, and generate daily/weekly/monthly reports to break down how they spend (e.g. spending categories, whether they spend above their income, etc.)