tianqi-zhu / 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/command/DeleteCommand.java lines 18-22:

    /**
     * Execute the delete command. 
     * 
     * @param tasklist current list of tasks.
     */

Example from src/main/java/duke/command/DoneCommand.java lines 20-24:

    /**
     * Execute the command to mark a task as done. 
     * 
     * @param taskList Current list of tasks.
     */

Example from src/main/java/duke/command/FindCommand.java lines 18-22:

    /**
     * Find the print the task when executed.
     * 
     * @param taskList current taskList
     */

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/gui/DialogBox.java lines 52-58:

    /**
     * generate a new userdialog box with user message and avatar
     *
     * @param text the user message to be displayed in the dialog box
     * @param img user avatar
     * @return new dialog box generated
     */

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

    /**
     * generate a new duke dialog box with message wne avatar. Orientation is left-right flip of user dialog box.
     *
     * @param text the duke message to be displayed in the dialog box
     * @param img duke avatar
     * @return new dialog box generated
     */

Example from src/main/java/duke/gui/MainWindow.java lines 44-49:

    /**
     * get the result of duke according to user input
     *
     * @param userInput string of user input
     * @return the response of duke
     */

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 👍

Aspect: Binary files in repo

• Duke.jar

• lib\apiguardian-api-1.0.0.jar

• lib\junit-jupiter-5.4.2.jar

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

❗ 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.