Skip to content

Sharing iP code quality feedback [for @yucheng11122017]Β #3

@nus-se-bot

Description

@nus-se-bot

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/Ui.java lines 36-40:

    /**
     * Return string saying bye.
     *
     * @return String saying bye.
     */

Example from src/main/java/duke/Ui.java lines 65-70:

    /**
     * Return string of the list of current tasks.
     *
     * @param tasks the current list of tasks.
     * @return string of list of current tasks.
     */

Example from src/main/java/duke/command/Command.java lines 93-100:

    /**
     * Command will execute.
     *
     * @param tasks the task to be executed in the command.
     * @param ui the ui to interact with the user.
     * @param fileManager the filemanger that manages the storage of duke.
     * @throws DukeException if command has issues.
     */

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 cs2103@comp.nus.edu.sg if you want to follow up on this post.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions