Sharing iP code quality feedback [for @matthanfoo] - Round 2 #4
Description
@matthanfoo 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
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/Chatty.java lines 14-17:
/**
* use the default filePath to read in any stored in the file corresponding to the filePath into a Storage object
* which is then read into a TaskList object and passed to the UI to use when interacting with the user
*/Example from src/main/java/Chatty.java lines 31-33:
/**
* Save all working tasks before terminating
*/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 6cceed1:
Resolve merge conflicts
Parser execute method currently has much more than 50 LoC
and has too many levels/layers of nesting
Add new methods to Parser class in order to increase level of abstraction and also reduce length of execute method
Add recur functionality to create repeated tasks at daily/weekly/monthly/yearly intervals for a specified number of repetitions
- body not wrapped at 72 characters: e.g.,
Add new methods to Parser class in order to increase level of abstraction and also reduce length of execute method
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.