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

[soc-se-bot-blue]

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

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/chingu/Chingu.java lines 52-57:

    /**
     * Collect Command from the user each time and respond to user's command to Chingu
     *
     * @param userInput which consist of command
     * @return string Response to the command of the user
     */

Example from src/main/java/chingu/Parser.java lines 89-95:

    /**
     * Parse Command that adds ToDo
     *
     * @param description about ToDo
     * @return ToDo Task that is created
     * @throws ToDosException if necessary details are missing from the ToDo
     */

Example from src/main/java/chingu/Parser.java lines 110-117:

    /**
     * Parse Command that adds Deadline
     *
     * @param description about Deadline
     * @return Deadline that is created
     * @throws DeadlineException if necessary details are missing from the Deadline
     * @throws DateException if format of the date given is wrong
     */

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

Make following changes to the source code

Fix the save functions to allow Jar File to automatically save all tasks when program ends

Added JavaDocs to the necessary public functions and classes

• body not wrapped at 72 characters: e.g., Fix the save functions to allow Jar File to automatically save all tasks when program ends

possible problems in commit 686336a:

Increase the size of the app

App was too small. It was difficult to fit in list of task which contains more than 3 tasks.

• body not wrapped at 72 characters: e.g., App was too small. It was difficult to fit in list of task which contains more than 3 tasks.

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.