Sharing iP code quality feedback [for @ShanHng] - Round 2

[soc-se-script]

@ShanHng 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

Example from src/main/java/babe/Babe.java lines 56-121:

    public String getResponse(String input) {
        String output = "";

        try {
            ArrayList<String> parseOutputs = Parser.parse(input);
            String instruction = parseOutputs.get(0);

            if (instruction.equals("bye")) {
                output = Ui.sayBye();
                System.exit(0);

            } else if (instruction.equals("list")) {
                output = Ui.printList(this.taskList);

            } else if (instruction.equals("mark")) {
                int index = Integer.parseInt(parseOutputs.get(1));
                String taskString = this.taskList.markTask(index);
                Storage.save(this.taskList);
                output = Ui.notifyMark(taskString);

            } else if (instruction.equals("unmark")) {
                int index = Integer.parseInt(parseOutputs.get(1));
                String taskString = this.taskList.unmarkTask(index);
                Storage.save(this.taskList);
                output = Ui.notifyUnmark(taskString);

            } else if (instruction.equals("todo")) {
                String taskString = this.taskList.addToDo(parseOutputs.get(1), false);
                Storage.save(this.taskList);
                output = Ui.notifyAddTask(taskString, this.taskList.length());

            } else if (instruction.equals("deadline")) {
                String taskString = this.taskList.addDeadline(parseOutputs.get(1), parseOutputs.get(2), false);
                Storage.save(this.taskList);
                output = Ui.notifyAddTask(taskString, this.taskList.length());

            } else if (instruction.equals("event")) {
                String taskString = this.taskList.addEvent(parseOutputs.get(1),
                        parseOutputs.get(2),
                        parseOutputs.get(3),
                        false);
                Storage.save(this.taskList);
                output = Ui.notifyAddTask(taskString, this.taskList.length());

            } else if (instruction.equals("delete")) {
                ArrayList<String> indices = new ArrayList<>(parseOutputs.subList(1, parseOutputs.size()));
                ArrayList<String> removedTasks = this.taskList.deleteTasks(indices);
                Storage.save(this.taskList);
                output = Ui.notifyDelete(removedTasks, this.taskList.length());

            } else if (instruction.equals("find")) {
                String searchKey = parseOutputs.get(1);
                ArrayList<String> foundTasks = this.taskList.findTasks(searchKey);
                output = Ui.notifyFindResults(foundTasks);

            } else {
                throw new NonsenseInputException();
            }
        } catch (Exception e1) {
            output = Ui.notifyException(e1);
        } catch (AssertionError e2) {
            output = Ui.notifyError(e2);
        }

        return output;
    }

Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods e.g., extract some code blocks into separate methods. You may ignore this suggestion if you think a longer method is justified in a particular case.

Aspect: Class size

No easy-to-detect issues 👍

Aspect: Header Comments

Example from src/main/java/babe/TaskList.java lines 125-130:

    /**
     * Find a task in the TaskList that contains the searchKey entirely.
     *
     * @param searchKey A String input by the user.
     * @return An ArrayList containing Strings of all the Tasks found.
     */

Example from src/test/java/babe/TaskListTest.java lines 12-14:

    /**
     * A unit test for TaskList#addToDo(String, boolean) method
     */

Example from src/test/java/babe/TaskListTest.java lines 21-23:

    /**
     * A unit test for TaskList#addToDo(String, boolean) method
     */

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 (Subject Only)

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.