@larrywang0701 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
Example from src/main/java/command/CommandDeadlineHandler.java lines 26-27:
Example from src/main/java/command/CommandDeleteHandler.java lines 24-25:
}
catch (NumberFormatException e) {Example from src/main/java/command/CommandDurationHandler.java lines 26-27:
Suggestion: As specified by the coding standard, use egyptian style braces.
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/main/Ui.java lines 38-99:
public void start(Stage primaryStage) throws Exception {
INSTANCE = this;
this.window = primaryStage;
AnchorPane anchorPane = new AnchorPane();
ScrollPane scrollPane = new ScrollPane();
VBox dialogContainer = new VBox();
this.dialogContainer = dialogContainer;
scrollPane.setContent(dialogContainer);
scrollPane.setHbarPolicy(ScrollPane.ScrollBarPolicy.NEVER);
scrollPane.setVbarPolicy(ScrollPane.ScrollBarPolicy.AS_NEEDED);
TextField messageInputArea = new TextField();
messageInputArea.setPrefSize(350, 20);
messageInputArea.setLayoutX(0);
messageInputArea.setLayoutY(600);
Button sendMessageButton = new Button("Send");
sendMessageButton.setPrefSize(50, 20);
sendMessageButton.setLayoutX(350);
sendMessageButton.setLayoutY(600);
scrollPane.setPrefSize(400, 590);
anchorPane.getChildren().addAll(scrollPane, messageInputArea, sendMessageButton);
Scene mainScene = new Scene(anchorPane);
primaryStage.setTitle("Chat with " + Main.getInstance().getName());
primaryStage.setResizable(false);
primaryStage.setMinHeight(600);
primaryStage.setMinWidth(400);
anchorPane.setPrefSize(400, 600);
primaryStage.setScene(mainScene);
primaryStage.show();
primaryStage.setOnCloseRequest(event -> {
ButtonType exitBtn = new ButtonType("Exit");
ButtonType cancelBtn = new ButtonType("Cancel");
Alert closeConfirmation = new Alert(Alert.AlertType.CONFIRMATION,"", cancelBtn, exitBtn);
closeConfirmation.setHeaderText("Do you really want to exit?");
closeConfirmation.showAndWait().ifPresent(
result->{
if(result == exitBtn) {
this.byeAndExit();
}
}
);
event.consume();
});
sendMessageButton.setOnMouseClicked(event -> {
String message = messageInputArea.getText();
messageInputArea.setText("");
this.addMessageBubble(message, true, false);
Main.getInstance().getParser().executeCommand(message);
});
messageInputArea.setOnAction(event -> {
String message = messageInputArea.getText();
messageInputArea.setText("");
this.addMessageBubble(message, true, false);
Main.getInstance().getParser().executeCommand(message);
});
this.portraitUser = new Image(this.getClass().getResourceAsStream("/images/Portrait_User.png"));
this.portraitBot = new Image(this.getClass().getResourceAsStream("/images/Portrait_Bot.png"));
Main.getInstance().loadTaskListFromFile();
Main.getInstance().getParser().executeCommand("intro");
}Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods e.g., extract some code blocks into separate 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/command/Parser.java lines 19-24:
/**
* Register a new command
*
* @param header the command's header
* @param handler The command's handler
*/Example from src/main/java/command/Parser.java lines 29-33:
/**
* Execute a command
*
* @param command the full command
*/Example from src/main/java/main/Main.java lines 49-53:
/**
* Main function for the program
*
* @param args The arguments from JVM
*/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
possible problems in commit 256371f:
Add error handling for exceptions when reading file
Add an error message box to tell the user there is an error and ask the user what to do when the program can not correctly load the task list from file.
- body not wrapped at 72 characters: e.g.,
Add an error message box to tell the user there is an error and ask the user what to do when the program can not correctly load the task list from file.
Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).
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