Sharing iP code quality feedback [for @riakhaitan]

[nus-se-bot]

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

Example from src/main/java/Duke.java lines 58-59:

                    }
                    catch(DukeInvalidTodo e) {

Example from src/main/java/duke/Storage.java lines 79-80:

            }
            else {

Suggestion: As specified by the coding standard, use egyptian style braces.

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.java lines 15-20:

    /**
     * Method containing the main execution of the Chat Bot.
     * @param args
     * @throws DukeExceptions
     * @throws IOException
     */

Example from src/main/java/duke/Parser.java lines 8-12:

    /**
     * Method to split the string input with a forward slash.
     * @param input user input.
     * @return String[] array after splitting.
     */

Example from src/main/java/duke/Parser.java lines 17-21:

    /**
     * Method to split the string input with a white space.
     * @param input user input.
     * @return String[] array after splitting.
     */

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)

possible problems in commit 7e9f3b7:

find

• Perhaps too short (?)

possible problems in commit 0d9e8c2:

coding standard

• Not in imperative mood (?)

Suggestion: Follow the given conventions for Git commit messages for future commits (no need to modify past commit messages).

Aspect: Binary files in repo

• src\main\java\Duke.class

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

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