Sharing iP code quality feedback [for @remuslum] - Round 2 #7
Description
@remuslum 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/duke/Duke.java lines 181-184:
/**
* You should have your own function to generate a response to user input.
* Replace this stub with your completed method.
*/Example from src/main/java/duke/Storage.java lines 52-57:
/**
* At the end of the session, the textfile is properly updated.
* @param taskList the final task list before ending the session
* @param filePath the path of the updated textfile
* @throws DukeException if the filepath is incorrectly inputted
*/Example from src/main/java/duke/TaskList.java lines 39-43:
/**
* Convert a Deadline task description into an instance of the Deadline Class.
* @param taskDescription description of Deadline task
* @return Deadline
*/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 a3befbe:
Modified constructor to pass smoke tests
- Not in imperative mood (?)
possible problems in commit e0e9d73:
Updated README.md
- Not in imperative mood (?)
possible problems in commit a7af50a:
Finalised features and JAR file created
- Not in imperative mood (?)
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 [email protected] if you want to follow up on this post.