Sharing iP code quality feedback [for @annabellekk] #1
Description
@annabellekk 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
Example from src/main/java/Dawn/Dawn.java lines 1-1:
package Dawn;Example from src/main/java/Dawn/DawnException.java lines 1-1:
package Dawn;Example from src/main/java/Dawn/Deadline.java lines 1-1:
package Dawn;Suggestion: Follow the package naming convention specified by the coding standard.
Aspect: Class Name Style
No easy-to-detect issues 👍
Aspect: Dead Code
Example from src/test/java/Dawn/ParserTest.java lines 9-9:
// public void Parser_invalidCommand_ExceptionThrown() {Example from src/test/java/Dawn/ParserTest.java lines 10-10:
// try {Example from src/test/java/Dawn/ParserTest.java lines 11-11:
// new Parser("hello", "world");Suggestion: Remove dead code from the codebase.
Aspect: Method Length
No easy-to-detect issues 👍
Aspect: Class size
No easy-to-detect issues 👍
Aspect: Header Comments
No easy-to-detect issues 👍
Aspect: Recent Git Commit Message
No easy-to-detect issues 👍
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.