-
Notifications
You must be signed in to change notification settings - Fork 437
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
[Lionel Lim] iP #222
base: master
Are you sure you want to change the base?
[Lionel Lim] iP #222
Conversation
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.
Generally, most of the code seems to follow the coding convention. However, mainly could check on the JavaDoc comments to ensure that the descriptions and @params description ends with a period, and there are some JavaDoc comments which are incomplete with just "..." written. Also, there are one or two variable/methods names that could be reviewed. Other than that, others looks good!
*/ | ||
public static Command parse(String fullCommand) throws Exception { | ||
String[] splitCommand = fullCommand.split(" ", 2); | ||
String[] params; |
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.
Perhaps you could use another naming that could show better that it is a multivalued variables e.g. commandWords ?
|
||
/** | ||
* The storage deals with loading tasks from the file and saving tasks in the file | ||
* |
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.
Perhaps the description for the JavaDoc comment could end with a period, to follow the coding conventions. I think I noticed this for other methods as well.
* Constructor of empty list | ||
*/ | ||
public TaskList() { | ||
} |
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.
Perhaps could remove this if it is not necessary, since there is a default constructor?
* ... | ||
*/ | ||
public void taskDeleted(Task task, TaskList tasks) { | ||
System.out.println("Noted. I've removed this task: "); |
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.
Perhaps you can use verbs to name the methods?
class Task { | ||
private final String name; | ||
private boolean done = false; | ||
|
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.
Perhaps this could be named as isDone instead?
* Constructor | ||
* | ||
* @param filePath File path of the storage file | ||
*/ |
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.
Perhaps the description for the @param should also end with a period, similarly for other JavaDoc comments
No description provided.