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

[nus-se-bot]

@jiangsuwangjing 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/alex/command/MarkCommand.java lines 10-10:

    private boolean markDone;

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

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/test/java/alex/MockUi.java lines 26-30:

    /**
     * Return the string to be printed when the task count is requested
     * @param count the count of tasks
     * @return the message to be printed
     */

Example from src/main/java/alex/Storage.java lines 57-60:

    /**
     * Load all the tasks stored in the file directory
     * @return a TaskList containing all the tasks
     */

Example from src/main/java/alex/Storage.java lines 99-103:

    /**
     * Delete a line in file
     * @param index the index of the line starting from 1
     * @throws IOException
     */

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 Messages

possible problems in commit c2958f2:

Implement mass delete

Updated parser function in DeleteCommand to parse the mass delete operation.

Created new method in Parser that parses the range from string representation 'x-y' into a pair of integer. This functionality is extracted because it is used in all the mass operations for better SLAP.

• body not wrapped at 72 characters: e.g., Updated parser function in DeleteCommand to parse the mass delete operation.

possible problems in commit f13a521:

Implement mass mark and unmark

Updated MarkCommand parser that identifies the range of indexes for the mass operation in the format of 'x-y' that represents the start and end of the tasks to mark.
Updated TaskList that handles mass mark and unmark operations.

• body not wrapped at 72 characters: e.g., Updated MarkCommand parser that identifies the range of indexes for the mass operation in the format of 'x-y' that represents the start and end of the tasks to mark.

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 👍

---

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