-
Notifications
You must be signed in to change notification settings - Fork 233
[CS2113-F14-2] CEGStudyBuddy #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
[CS2113-F14-2] CEGStudyBuddy #36
Conversation
…ses-of-members Clear expense amounts upon deletion. To implement: logic to delete ex…
| title += " " + parts[i]; | ||
| i += 1; | ||
| } | ||
| // reset i back to the ending element of title |
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.
Avoid comments for your own/coder's reference. Write comments for the reader's reference to maximize readability.
| } | ||
| // reset i back to the ending element of title | ||
| i -= 1; | ||
| } else if (parts[i].startsWith("mc/")) { |
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.
Avoid the usage of magic strings
| } else if (parts[i].startsWith("mc/")) { | ||
| mc = Integer.parseInt(parts[i].substring(3)); | ||
| } else if (parts[i].startsWith("y/")) { | ||
| y = Integer.parseInt(parts[i].substring(2)); |
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.
Avoid the usage of magic numbers as well.
| @@ -1,38 +1,369 @@ | |||
|
|
|||
| # Developer Guide | |||
|
|
|||
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.
Your developer guide is concise and detailed! Keep up your great work!
docs/DeveloperGuide.md
Outdated
| ### Command Component | ||
| All of CEGStudyBuddy’s commands have their own command class, which are subclasses of an abstract Command class. | ||
|
|
||
|  |
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.
If i recall, Prof Akshay said to remove the non-standard icons beside the class in the diagram
docs/DeveloperGuide.md
Outdated
| - It creates a `PlanData` folder to store data if one doesn’t already exist. | ||
| - It loads the user’s course plan at startup and saves changes automatically. | ||
|
|
||
|  |
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.
Are the names in the diagram correct? Think should have semicolons before the name - eg. :SwitchPlanCommand instead of SwitchPlanCommand
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.
maybe can add a few activation bars
| --- | ||
|
|
||
| ## Design | ||
|
|
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.
Maybe can consider having an overall architecture diagram/explanation for easier visualisation of all the components
jiajun2002
left a comment
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.
nice diagram overall!
Branch defined mods
Storage better
Rename file
Branch alex ppp
DG contribution
Update UserGuide.md
…into branch-Final
…into branch-Final
Branch final
CEGStudyBuddy is a desktop application that tracks and plans university courses efficiently for NUS Computer Engineering students who want a structured academic roadmap.