hongyi6328 / ip Goto Github PK

@Hongyi6328 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/DialogBox.java lines 51-57:

    /**
     * Create a dialog on the user's side. Wraps text.
     *
     * @param text The string to be displayed.
     * @param img The user's avatar.
     * @return A dialog box.
     */

Example from src/main/java/duke/ui/DialogBox.java lines 64-70:

    /**
     * Create a dialog on the Duke's side. Wraps text. Flips the orientation.
     *
     * @param text The string to be displayed.
     * @param img Duke's avatar.
     * @return A dialog box.
     */

Example from src/main/java/duke/util/TaskList.java lines 86-91:

    /**
     * Mark the index-th Task as undone and returns a string as a follow-up of the operation.
     *
     * @param index The index indicating which Task to mark.
     * @return A string as a response of the operation.
     */

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

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

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

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/Duke.java lines 99-103:

    /**
     * The main logic that runs a chatbot.
     *
     * @param args String arguments for starting the logic.
     */

Example from src/main/java/duke/task/Task.java lines 86-91:

    /**
     * An overloaded version of getFileRepresentation()
     *
     * @param label A capital letter that indicates the type of the task.
     * @return A string representation of the task in the file.
     */

Example from src/main/java/duke/util/TaskList.java lines 70-75:

    /**
     * Mark the index-th Task as done and returns a string as a follow-up of the operation.
     *
     * @param index The index indicating which Task to mark.
     * @return A string as a response of the operation.
     */

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

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