mrmrinal / ip Goto Github PK

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 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: Header Comments

Example from src/main/java/duke/DialogBox.java lines 52-58:

    /**
     * Method that returns new DialogBox for the bot.
     *
     * @param text the text that is supposed to be shown
     * @param img the image of the bot
     * @return the user dialogue box back to the GUI interface
     */

Example from src/main/java/duke/DialogBox.java lines 63-69:

    /**
     * Method that returns new DialogBox for the user.
     *
     * @param text the text that is supposed to be shown
     * @param img the image of the user
     * @return the user dialogue box back to the GUI interface
     */

Example from src/main/java/duke/Gui.java lines 11-14:

    /**
     * Bot greeting which shows up whenever the bot is instantiated.
     * @return String that shows the user greeting
     */

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)

No easy-to-detect issues 👍

ℹ️ The bot account @cs2103-bot used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact [email protected] if you want to follow up on this post.

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/DialogBox.java lines 56-62:

    /**
     * Method that returns new DialogBox for the bot.
     *
     * @param text the text that is supposed to be shown
     * @param img the image of the bot
     * @return the user dialogue box back to the GUI interface
     */

Example from src/main/java/duke/DialogBox.java lines 67-73:

    /**
     * Method that returns new DialogBox for the user.
     *
     * @param text the text that is supposed to be shown
     * @param img the image of the user
     * @return the user dialogue box back to the GUI interface
     */

Example from src/main/java/duke/Duke.java lines 50-55:

    /**
     * You should have your own function to generate a response to user input.
     * Replace this stub with your completed method.
     * @param input the input for which the bot has to make a response
     * @return The string that dukebot outputs
     */

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)

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 @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 [email protected] if you want to follow up on this post.