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/Duke.java lines 47-82:
public static String renderTask(Task task) {
final var dateFormatter = DateTimeFormatter.ofPattern("MMM d yyyy");
final TaskType taskType = TaskType.identifyTask(task);
final String statusIcon = task.getStatusIcon();
final String taskIcon = taskType.getTaskIcon();
switch (taskType) {
case TODO:
return String.format(
"[%s][%s] %s",
taskIcon,
statusIcon,
task.getDescription()
);
case DEADLINE:
var deadline = (Deadline) task;
return String.format(
"[%s][%s] %s (by: %s)",
taskIcon,
statusIcon,
deadline.getDescription(),
deadline.getDeadline().format(dateFormatter)
);
case EVENT:
var event = (Event) task;
return String.format(
"[%s][%s] %s (at: %s)",
taskIcon,
statusIcon,
event.getDescription(),
event.getTime().format(dateFormatter)
);
default:
throw new UnsupportedOperationException("task type is not a valid enum value");
}
}Example from src/main/java/duke/Parser.java lines 47-98:
public static String runCommand(TaskList tasks, Storage storage, String input) throws Exception {
final var parameters = input.split(" ");
assert parameters.length > 0;
final var command = parameters[0];
final var remaining = input.replace(command, "").strip();
if (command.equals("list")) {
if (!remaining.equals("")) {
throw new Exception("The list command cannot take in any parameters.");
}
return Duke.renderTaskList(tasks);
} else if (command.equals("done")) {
final int i = Integer.parseInt(remaining) - 1;
final Task task = toggleTask(tasks, storage, i, true);
return String.join(
"\n",
"Nice! I've marked this task as done:",
" " + Duke.renderTask(task)
);
} else if (command.equals("delete")) {
final int i = Integer.parseInt(remaining) - 1;
final Task task = popTask(tasks, storage, i);
return String.join(
"\n",
"Noted. I've removed this task:",
" " + Duke.renderTask(task),
String.format("Now you have %d tasks in the list.", tasks.size())
);
} else if (command.equals("todo")) {
if (remaining.equals("")) {
throw new Exception("The description of a todo cannot be empty.");
}
final Task task = Parser.parseTaskLine(tasks, remaining, TaskType.TODO);
addTask(tasks, storage, task);
return Duke.renderTaskAdded(tasks, task);
} else if (command.equals("deadline") && remaining.contains("/by")) {
final Task task = Parser.parseTaskLine(tasks, remaining, TaskType.DEADLINE);
addTask(tasks, storage, task);
return Duke.renderTaskAdded(tasks, task);
} else if (command.equals("event") && remaining.contains("/at")) {
final Task task = Parser.parseTaskLine(tasks, remaining, TaskType.EVENT);
addTask(tasks, storage, task);
return Duke.renderTaskAdded(tasks, task);
} else if (command.equals("find")) {
if (remaining.equals("")) {
throw new Exception("The search query cannot be empty.");
}
return Duke.renderFoundTasks(tasks.find(remaining));
} else {
throw new Exception("I'm sorry, but I don't know what that means :-(");
}
}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/Duke.java lines 84-87:
/**
* Render welcome message.
* @return Welcome message.
*/Example from src/main/java/duke/Duke.java lines 92-96:
/**
* Render an exception message.
* @param e Exception.
* @return Exception message.
*/Example from src/main/java/duke/Duke.java lines 121-126:
/**
* Print banner for a newly added task.
* @param tasks List of tasks.
* @param task Newly added task.
* @return String representing newly added task with list of tasks.
*/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 👍
❗ 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 @nus-se-bot 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