Sharing iP code quality feedback [for @lynnlow175]

[soc-se-bot-blue]

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

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

            //ignore;

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/duke/Task.java lines 35-37:

    /**
     * A method that sets the done flag to false.
     */

Example from src/main/java/duke/Ui.java lines 169-171:

    /**
     * Empty find command description.
     */

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 65dc662:

Improved Code Quality

Long method is written.

This affects code readability.

The long method was shortened by abstracting out a chunk into a new method.

This ensures that the logic flow is still the same as the shortened method
will still call the new method.

• Not in imperative mood (?)
• body not wrapped at 72 characters: e.g., The long method was shortened by abstracting out a chunk into a new method.

possible problems in commit 99d4da3:

Added Assertion Statements

There exist certain assumptions made about the arguments being
passed into some methods.

It is important that we add assertion to check for possible bugs and
terminate the execution so that it is more safe.

Assertion statements have been used within the method to check for certain
characteristics of the arguments (eg. String input is not null)

• Not in imperative mood (?)
• body not wrapped at 72 characters: e.g., Assertion statements have been used within the method to check for certain

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.