-
Notifications
You must be signed in to change notification settings - Fork 0
Sharing iP code quality feedback [for @alyssaongyx] - Round 2 #6
Description
@alyssaongyx 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
Example from src/main/java/ally/Ally.java lines 42-42:
// public void run() {Example from src/main/java/ally/Ally.java lines 43-43:
// ui.start();Example from src/main/java/ally/Ally.java lines 44-44:
// boolean isExit = false;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
Example from src/main/java/ally/Ui.java lines 37-39:
/**
* Function that provides the starting message and greeting.
*/Example from src/main/java/ally/Ui.java lines 46-51:
/**
* Function that provides the bye message when the user
* ends the chatbot.
*
* @return
*/Example from src/main/java/ally/tasks/AllyList.java lines 22-25:
/**
* Function to add tasks from the input into the arraylist.
* @param task
*/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 490dc07:
Add Help Command to show the list of formats of the commands for a new user
- Longer than 72 characters
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.