Sharing iP code quality feedback [for @Nihirraa] - Round 2 #5
Description
@Nihirraa 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/espresso/Espresso.java lines 24-30:
/**
* ,
* The main handler of the chatbot.
*
* @throws InvalidCommandException if an invalid command is entered
* @throws ParseException if a task's date is in an invalid format
*/Example from src/main/java/espresso/gui/Main.java lines 32-36:
/**
* The main method that launches the application.
*
* @param args Command-line arguments passed to the program.
*/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 f1debb3:
Ensure conflict detection between EventTask and DeadlineTask
- Enhanced conflict detection to prevent overlaps between EventTask and DeadlineTask.
- Conflict detection checks if a deadline occurs within the time span of an event.
- Throws an when tasks with scheduling conflicts are detected.
- body not wrapped at 72 characters: e.g.,
- Enhanced conflict detection to prevent overlaps between EventTask and DeadlineTask.
possible problems in commit b0c08d9:
Add assertions to MainWindow class
Assertions were added to document important assumptions in the Espresso instance, user input, and bot response. These checks enhance code robustness.
- body not wrapped at 72 characters: e.g.,
Assertions were added to document important assumptions in the Espresso instance, user input, and bot response. These checks enhance code robustness.
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
Suggestion: Avoid committing binary files (e.g., *.class, *.jar, *.exe) or third-party library files in to the repo.
❗ 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.