eman-kom / duke-task-tracker-bot Goto Github PK

@eman-kom 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/seedu/duke/Duke.java lines 34-39:

    /**
     * Bridge between gui and the application
     *
     * @param input The user input
     * @return The response of the application
     */

Example from src/main/java/seedu/duke/Parser.java lines 24-26:

    /**
     * A dictionary converting string to their appropriate commands
     */

Example from src/main/java/seedu/duke/Parser.java lines 40-46:

    /**
     * Find and returns the appropriate command based on user input
     *
     * @param fullCmd The entire user input
     * @return A command object corresponding to the input command type
     * @throws DukeException There is no command or the command input has the wrong type
     */

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.

@eman-kom 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/seedu/duke/Duke.java lines 36-40:

    /**
     * Runner for the program.
     * Saves task list into save file for every command run.
     * Stops if command == "bye".
     */

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

    /**
     * Used in the GUI to get responses from Duke
     *
     * @param input The command to be entered
     * @return The response of Duke
     */

Example from src/main/java/seedu/storage/TaskList.java lines 59-64:

    /**
     * Find all tasks with the given string in the task list
     *
     * @param search The string to be searched
     * @return A list in string representation of all the tasks with the substring found
     */

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