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

[soc-se-script]

@chinpcbenjamin 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/test/java/benjaminbot/BenjaminBotTest.java lines 11-11:

        // tests TaskList's getTaskCount(), addTask(Task t), and removeTask(int i);

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/benjaminbot/Storage.java lines 51-57:

    /**
     * Decides, based on the current entry retrieved from the file specified by this Storage instance, the type of
     * task that it is, and accordingly adds that task to the TaskList instance
     * @param s A string representing one task, that was retrieved from the list of saved tasks from this
     *          Storage instance.
     * @param arr The TaskList to which the saved task will be loaded to.
     */

Example from src/main/java/benjaminbot/DialogBox.java lines 51-57:

    /**
     * Create a DialogBox that display's the user's input.
     *
     * @param text The dialog text to display.
     * @param image The image that represents the user.
     * @return DialogBox that display's the user's input.
     */

Example from src/main/java/benjaminbot/DialogBox.java lines 62-68:

    /**
     * Create a DialogBox that display's the BenjaminBot's input.
     *
     * @param text The dialog text to display.
     * @param image The image that represents the BenjaminBot.
     * @return DialogBox that display's BenjaminBot's input.
     */

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 Messages

No easy-to-detect issues 👍

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.