Skip to content

Sharing iP code quality feedback [for @bbryant824] - Round 2 #15

Description

@nus-se-script

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

No easy-to-detect issues 👍

Aspect: Recent Git Commit Message

possible problems in commit 8e7b606:


Improve error handling for mark and unmark commands

Enhanced error messages for mark and unmark commands to provide users with clear and meaningful feedback. Added validation for invalid or out-of-range task numbers, ensuring proper input formats are required. Updated Parser to handle non-numeric inputs and missing task numbers with appropriate error messages.


  • body not wrapped at 72 characters: e.g., Enhanced error messages for mark and unmark commands to provide users with clear and meaningful feedback. Added validation for invalid or out-of-range task numbers, ensuring proper input formats are required. Updated Parser to handle non-numeric inputs and missing task numbers with appropriate error messages.

possible problems in commit 55501aa:


Update Javadoc for Kobe class

Enhanced the documentation for the Kobe class to provide a clear
understanding of its role as the main controller for the chatbot
application.

- Documented the constructor, detailing how the tasks are loaded from
  storage and initialized.
- Provided detailed explanations for the getResponse() method,
  describing how user input is processed and how different commands
  are executed.
- Included an explanation of error handling for invalid input.

By improving the Javadoc for this core class, it will be easier for
future developers to follow the flow of the application and understand
how the chatbot processes commands and interacts with the user interface.


  • body not wrapped at 72 characters: e.g., how the chatbot processes commands and interacts with the user interface.

Suggestion: Follow the given conventions for Git commit messages for future commits (do not modify past commit messages as doing so will change the commit timestamp that we used to detect your commit timings).

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