Sharing iP code quality feedback [for @teominghuang] - Round 2

[nus-se-script]

@teominghuang 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/Duke.java lines 28-34:

    /**
     * Act as a bridge between the business logic of the code and the models. It parses commands from the
     * User Interface and returns a response based on the execution of the command.
     *
     * @param inputCommand Command provided by the user in the text input.
     * @return A string response resulted from the business logic of the code.
     */

Example from src/main/java/duke/command/Commands.java lines 16-20:

    /**
     * Aid in exiting the program if the command calls for it.
     *
     * @return the apt exit instruction.
     */

Example from src/main/java/duke/parser/Parser.java lines 20-25:

    /**
     * Trim the input of the user.
     *
     * @param input Input to be trimmed.
     * @return Return a trimmed output of the input.
     */

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

• src\main\java\duke\output\output.txt\artifacts\Individual_Project_jar\Individual_Project.jar

• src\out\Individual_Project.jar

Suggestion: Avoid committing binary files (e.g., *.class, *.jar, *.exe) or third-party library files in to the repo.

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