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

[soc-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, 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

Example from src/main/java/duke/Duke.java lines 87-88:

                    }
                    catch(DukeInvalidTodo e) {

Example from src/main/java/duke/Duke.java lines 126-127:

        }
        catch (DukeExceptions 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

Example from src/main/java/duke/Duke.java lines 42-42:

        //Ui.enterHalloumi(str);

Example from src/main/java/duke/Duke.java lines 76-76:

//                    System.out.println(array);

Example from src/main/java/duke/Duke.java lines 78-78:

//                        System.out.println(textSplit[i]);

Suggestion: Remove dead code from the codebase.

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 29-34:

    /**
     * Method containing the main execution of the Chat Bot.
     * @param
     * @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 48d87fc:

build.gradle : Update dependancies in the file to add JavaFX dependencies

• Longer than 72 characters

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.

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