Sharing iP code quality feedback [for @WinstonLeonard] - Round 2

[soc-se-bot-blue]

@WinstonLeonard 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

Example from src/main/java/duke/Duke.java lines 28-28:

        //String filePath = "../ip/src/main/data/duke.txt";

Example from src/main/java/duke/EventTypeHandler.java lines 35-35:

            //System.out.println(extractedSubstring);

Example from src/main/java/duke/Window.java lines 39-39:

        //scrollPane = new ScrollPane();

Suggestion: Remove dead code from the codebase.

Aspect: Method Length

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/duke/DialogBox.java lines 26-32:

    /**
     * DialogBox inside the GUI
     * @param l Label given to the GUI
     * @param iv ImageView given to the GUI
     * @param isUserDialog Whether this dialogbox is userdialog or duke dialog
     * @param content content to be displayed
     */

Example from src/main/java/duke/EventTypeHandler.java lines 23-27:

    /**
     * To handle the different type of tasks (T,D,E)
     * @param eventType
     * @throws EmptyDescriptionException
     */

Example from src/main/java/duke/Task.java lines 36-38:

    /**
     * Method to mark a task as done inside the taskList
     */

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 af7ebaa:

Handled invalid filepath

• Not in imperative mood (?)

possible problems in commit 72e7ee1:

Fixed styling and added more javadoc

• Not in imperative mood (?)

possible problems in commit d0e7202:

added Ui.png

• Not in imperative mood (?)

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 cs2103@comp.nus.edu.sg if you want to follow up on this post.