@zihaowrez We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).
IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.
Aspect: Tab Usage
No easy-to-detect issues 👍
Aspect: Naming boolean variables/methods
No easy-to-detect issues 👍
Aspect: Brace Style
No easy-to-detect issues 👍
Aspect: Package Name Style
No easy-to-detect issues 👍
Aspect: Class Name Style
No easy-to-detect issues 👍
Aspect: Dead Code
No easy-to-detect issues 👍
Aspect: Method Length
Example from src/main/java/duke/Parser.java lines 28-97:
public static Command parse(String input) throws DukeException {
input = input.trim();
String[] splited = input.split(" ", 2);
String firstWord = splited[0];
String remaining = "";
if (splited.length == 2) {
remaining = splited[1];
}
remaining = remaining.trim();
if (input.equals("bye")) {
return new ByeCommand();
} else if (input.equals("list")) {
return new ListCommand();
} else if (input.equals("help")) {
return new HelpCommand();
} else if (firstWord.equals("delete")) {
if (!remaining.matches("-?\\d+")) {
throw new DukeException("Must specify which task to delete");
}
return new DeleteCommand(Integer.parseInt(remaining));
} else if (firstWord.equals("mark")) {
if (!remaining.matches("-?\\d+")) {
throw new DukeException("Must specify which task to mark");
}
return new MarkCommand(Integer.parseInt(remaining));
} else if (firstWord.equals("unmark")) {
if (!remaining.matches("-?\\d+")) {
throw new DukeException("Must specify which task to unmark");
}
return new UnmarkCommand(Integer.parseInt(remaining));
} else if (firstWord.equals("find")) {
if (remaining.equals("")) {
throw new DukeException("Must specify what to find");
}
return new FindCommand(remaining);
} else if (firstWord.equals("edit")) {
if (remaining.equals("")) {
throw new DukeException("Must specify what to edit");
} else if (!remaining.matches("-?\\d+ .+")) {
throw new DukeException("Invalid format");
}
String[] indexText = remaining.split(" ", 2);
return new EditCommand(Integer.parseInt(indexText[0]), indexText[1]);
} else if (firstWord.equals("todo")) {
if (remaining.equals("")) {
throw new DukeException("The description of a todo cannot be empty");
}
return new TodoCommand(remaining);
} else if (firstWord.equals("deadline")) {
String[] descAndBy = remaining.split(" /by ", 2);
if (descAndBy.length < 2) {
throw new DukeException("Incorrect format");
} else if (descAndBy[0].length() == 0) {
throw new DukeException("The description of a deadline cannot be empty");
}
DukeDateTime datetime = DukeDateTime.parse(descAndBy[1].trim());
return new DeadlineCommand(descAndBy[0].trim(), datetime);
} else if (firstWord.equals("event")) {
String[] descAndAt = remaining.split(" /at ", 2);
if (descAndAt.length < 2) {
throw new DukeException("Incorrect format");
} else if (descAndAt[0].length() == 0) {
throw new DukeException("The description of an event cannot be empty");
}
DukeDateTime datetime = DukeDateTime.parse(descAndAt[1].trim());
return new EventCommand(descAndAt[0].trim(), datetime);
} else {
return new UnrecognizedCommand();
}
}Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods. You may ignore this suggestion if you think a longer method is justified in a particular case.
Aspect: Class size
No easy-to-detect issues 👍
Aspect: Header Comments
Example from src/main/java/duke/gui/Launcher.java lines 9-11:
Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.
Aspect: Recent Git Commit Message (Subject Only)
No easy-to-detect issues 👍
Aspect: Binary files in repo
No easy-to-detect issues 👍
❗ You are not required to (but you are welcome to) fix the above problems in your iP, unless you have been separately asked to resubmit the iP due to code quality issues.
ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent