Skip to content
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

[Choo Jia Xin] iP #318

Open
wants to merge 58 commits into
base: master
Choose a base branch
from
Open

Conversation

ChooJiaXin
Copy link

No description provided.

@ChooJiaXin ChooJiaXin changed the title Choo Jia Xin iP [Choo Jia Xin] iP Aug 24, 2020
private boolean isDone;

/**
* Creates a new task with the specified description.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

JDoc guidelines suggest we should phrase constructors is like so :
Constructs....

Copy link

@blackonyyx blackonyyx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Standard wise:
Overall, not many code standard violations occured, good job for that.
Documentation was very well done at most parts, except for some constructors.
Couldnt nit pick very much for naming violations.

On the side of design: May be better to refactor to reduce the number of static methods used in the code base.

Good job overall!

Copy link

@claraadora claraadora left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would like to say that your code is very clean.
I have added some minor suggestions below.
I hope it helps! :)

*/
private void run() {
ui.loadTaskList(tasks);
ui.showGreetings();

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a minor suggestion based on personal preference. Maybe use 'print' instead of 'show'?

*
* @return Total number of tasks currently in the task list.
*/
public int totalNumberOfTasks() {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps add 'get' to the method name, i.e. getTotalNumberofTasks()?

* @param index Index of task to be retrieved.
* @return Task stored at the specified index.
*/
public Task getTask(int index) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just a personal preference too; maybe can add 'AtIndex' to the method name i.e. getTaskAtIndex.

*
* @param index Index of the task to be deleted.
*/
public void deleteTask(int index) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above regarding the addition of 'AtIndex'

*
* @return true if the task is done and returns false if the task is not done.
*/
public boolean hasDoneStatus() {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above regarding the addition of 'get' word to the method name i.e. getHasDoneStatus() or rather getIsDone()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants