Sharing iP code quality feedback [for @Rachelcoll] #4
Description
@Rachelcoll 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/topaz/command/FindCommand.java lines 13-16:
/**
* Create a FindCommand Object with keyword initialized to be "find";
* @param filter can be parsed to key used to search in task list.
*/Example from src/main/java/topaz/exception/InvalidStateException.java lines 10-13:
/**
* The invalid state input that caused the exception.
* @param state
*/Example from src/main/java/topaz/main/TaskList.java lines 108-112:
/**
* Find a task by searching for a keyword.
* @param filter
* @return task conatins the filter keyword in description
*/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 2349d0b:
Add Assertions to taskList related methods
Sometimes we may want to check if the method that calls taskList method
successfully manipulates the list inside the taskList.
In some cases programmer may forget to add new Task to the list when
writing methods for a new type of class.
Adding assertions to these methods can
verify assumptions about Internal
Invariants, Control-Flow Invariants, Preconditions, Post conditions, and
Class Invariants.
Assertions will remind the possible flaw in the terminal if it's asserted
to be false.
- body not wrapped at 72 characters: e.g.,
Assertions will remind the possible flaw in the terminal if it's asserted
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.