Sharing iP code quality feedback [for @wxchoong]

[nus-se-bot]

@wxchoong We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.

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/storage/Storage.java lines 54-55:

        }
        else {

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

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/commands/Command.java lines 32-36:

    /**
     * Set program exit flag.
     *
     * @param exit Exit flag (true or false)
     */

Example from src/main/java/storage/Storage.java lines 29-35:

    /**
     * Read tasks stored in specific file and load them into a <code>TaskList</code>.
     * Returns an ArrayList of <code>Task</code> objects.
     * The filepath has to be specified when constructing the <code>Storage</code> object.
     *
     * @throws FileNotFoundException If file specified is not found.
     */

Example from src/main/java/storage/Storage.java lines 60-65:

    /**
     * Initialise/ create directory and file at specific filepath for storing tasks.
     * The filepath has to be specified when constructing the <code>Storage</code> object.
     *
     * @throws IOException If the creation of file or directory is unsuccessful.
     */

Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement

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