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

[nus-se-script]

@PyromancerBoom 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/Launcher.java lines 15-15:

        // Application.launch(Duke.class, args);

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/Launcher.java lines 10-13:

    /**
     * The main entry point for application.
     * This method is used to launch the JavaFX application.
     */

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

    /**
     * Method to add a new todo task to the list
     * 
     * @param description The description of the task
     */

Example from src/main/java/duke/TaskList.java lines 33-38:

    /**
     * Method to add a new deadline task to the list
     * 
     * @param description The description of the task
     * @param dueDate     The due date of the task
     */

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

Remove Terminal Support, Refactor, Clean-up

Removed terminal support for the bot, the software can only be used with GUI now.

Cleaned up unused code, removed redundant statements, remove unused imports.

Refactor code more

• body not wrapped at 72 characters: e.g., Removed terminal support for the bot, the software can only be used with GUI now.

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.