Sharing iP code quality feedback [for @aceszhenwei]

[nus-se-bot]

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

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/Storage.java lines 70-76:

    /**
     * Will invoke save command to save the current list into data/duke.ser to be loaded in future
     * sessions. Then, it will bid farewell to the user.
     *
     * @param arr The list of tasks that Duke has for the current session.
     * @return An acknowledgement that the session has ended.
     */

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

    /**
     * Mark or un-mark the respective index of the task in the ArrayList given by the input.
     * Returns a string of an acknowledgement if successful, else returns an edge case warning.
     *
     * @param input The respective index of the ArrayList needed to be mark or unmarked.
     * @param arr The ArrayList with the current list of tasks.
     * @return Acknowledgement string.
     * @throws NumberFormatException If input is less than or equals to zero.
     */

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 (Subject Only)

possible problems in commit 287dd45:

Added Help Feature

• Not in imperative mood (?)

possible problems in commit c1843b1:

Added Credits

• Not in imperative mood (?)

possible problems in commit 402fd6c:

Fixed mark() exception error

• Not in imperative mood (?)

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

Aspect: Binary files in repo

• javadoc\member-search-index.zip

• javadoc\package-search-index.zip

• javadoc\type-search-index.zip

Suggestion: Avoid committing binary files (e.g., *.class, *.jar, *.exe) or third-party library files in to the repo.

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