Sharing iP code quality feedback [for @ForAeons]

[soc-se-bot]

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

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/database/Database.java lines 17-22:

    /**
     * Connect to the database.
     *
     * @throws SQLException
     *             if a database error occurs
     */

Example from src/main/java/database/Database.java lines 38-43:

    /**
     * Disconnect from the database.
     *
     * @throws SQLException
     *             if a database error occurs
     */

Example from src/main/java/database/Database.java lines 48-57:

    /**
     * Execute a SQL statement.
     *
     * @param sql
     *            the SQL statement to execute
     * @return a ResultSet object that contains the data produced by the given
     *         query.
     * @throws SQLException
     *             if a database error occurs
     */

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

possible problems in commit a5426f5:

Add help command
* Add explain abstract method to Command class
* Help command calls explain on the corresponding command

• No blank line between subject and body

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 👍

---

ℹ️ 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.