Sharing iP code quality feedback [for @RingoftheKing] - Round 2 #6
Description
@RingoftheKing 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
Example from src/main/java/BadApple/main/BadAppleException.java lines 1-1:
package BadApple.main;Example from src/main/java/BadApple/main/BadPingGuo.java lines 1-1:
package BadApple.main;Example from src/main/java/BadApple/main/Launcher.java lines 1-1:
package BadApple.main;Suggestion: Follow the package naming convention specified by the coding standard.
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/BadApple/main/BadPingGuo.java lines 51-54:
/**
* Attempt to make files and inform the user (Sunny) of its status
* @return an indication of whether the file creation was successful
*/Example from src/main/java/BadApple/main/BadPingGuo.java lines 67-71:
/**
* An entry point for the response Duke (Mari) gives
* @param input the text the user types into the text box
* @return the Response for javaFX Mari to respond with
*/Example from src/main/java/BadApple/main/MainWindow.java lines 39-43:
/**
* Upon setting up the Stage and starting the app, run the commands
* below.
* @param d a BadPingGuo instance.
*/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
No easy-to-detect issues 👍
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.