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

[soc-se-bot-blue]

@ryamgoh 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/duke/ui/Ui.java lines 46-51:

    /**
     * Display the added task
     *
     * @param size the size of the list
     * @param task the task added
     */

Example from src/main/java/duke/ui/Ui.java lines 66-70:

    /**
     * Display the marked task message
     *
     * @param task the task marked
     */

Example from src/main/java/duke/ui/Ui.java lines 75-79:

    /**
     * Display the unmarked task message
     *
     * @param task the task unmarked
     */

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 252be2c:

Add Help Command as part of the BCD Extension

This is another full commit message \n Added the help command to help the user navigate the bot

• body not wrapped at 72 characters: e.g., This is another full commit message \n Added the help command to help the user navigate the bot

possible problems in commit ddc71ff:

Add body to Commit Message

As per the last commit a491046, I abstracted parts of Parser class to improve code quality

• body not wrapped at 72 characters: e.g., As per the last commit a491046, I abstracted parts of Parser class to improve code quality

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.