Sharing iP code quality feedback [for @TehOPanas]

[nus-se-script]

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

Example from src/main/java/duke/task/Task.java lines 13-13:

    private boolean done;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

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

No easy-to-detect issues 👍

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/duke/Parser.java lines 24-31:

    /**
     *  Interpret input from user to give out commands
     *
     * @param input user input
     * @return corresponding commands to be executed by program
     * @throws DukeException for any error within the program
     * @throws DateTimeParseException for wrong date format input by user
     */

Example from src/main/java/duke/Storage.java lines 26-30:

    /**
     * Save the user's task list into a json file
     *
     * @param list user's task list
     */

Example from src/main/java/duke/Storage.java lines 66-71:

    /**
     * Overloaded method of load
     *
     * @param list
     * @param filePath
     */

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

Merge branch 'refs/heads/A-JavaDoc'
Fulfill branch requirement for iP

• No blank line between subject and body

Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).

Aspect: Binary files in repo

No easy-to-detect 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.