Skip to content

Sharing iP code quality feedback [for @junweimoo]Β #1

Open
@nus-se-bot

Description

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

Example from src/main/java/duke/tasks/Task.java lines 6-6:

    private boolean marked;

Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)

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

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