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

[nus-se-script]

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

Example from src/main/java/tesseract/main/Storage.java lines 23-23:

    private static final boolean FALSE = false;

Example from src/main/java/tesseract/main/Storage.java lines 29-29:

    protected boolean updated;

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

Example from src/main/java/tesseract/GUI/DialogBox.java lines 1-1:

package tesseract.GUI;

Example from src/main/java/tesseract/GUI/MainWindow.java lines 1-1:

package tesseract.GUI;

Suggestion: Follow the package naming convention specified by the coding standard.

Aspect: Class Name Style

No easy-to-detect issues 👍

Aspect: Dead Code

Example from src/main/java/tesseract/GUI/MainWindow.java lines 3-3:

//import javafx.application.Platform;

Example from src/main/java/tesseract/GUI/MainWindow.java lines 6-6:

//import javafx.scene.control.Dialog;

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/tesseract/command/Command.java lines 58-64:

    /**
     * Execute the command on the system.
     *
     * @param taskList The list of all current tasks.
     * @param ui       The user interface.
     * @param storage  The memory storage.
     */

Example from src/main/java/tesseract/command/Command.java lines 147-152:

    /**
     * Return a command generated from the input line.
     *
     * @param fullCmd The line of input.
     * @return A command to be executed.
     */

Example from src/main/java/tesseract/command/Command.java lines 184-189:

    /**
     * Check if the input string can be converted to an integer.
     *
     * @param str The input string to be tested.
     * @return True if the input string represents an integer, false otherwise.
     */

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 df45747:

Refactored all files for generation of jar file

• 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

No easy-to-detect issues 👍

❗ 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 [email protected] if you want to follow up on this post.