From d95c8069a6154c52e7f54a532d573d751daf0005 Mon Sep 17 00:00:00 2001 From: nvknow <1375782557@qq.com> Date: Fri, 30 Sep 2022 23:58:55 +0800 Subject: [PATCH] add more comments --- src/main/java/duke/Duke.java | 3 +++ src/main/java/duke/command/ByeCommand.java | 6 ++++++ src/main/java/duke/command/Command.java | 16 ++++++++++++++++ src/main/java/duke/command/DeadlineCommand.java | 7 +++++++ src/main/java/duke/command/DeleteCommand.java | 7 +++++++ src/main/java/duke/command/EventCommand.java | 7 +++++++ src/main/java/duke/command/FindCommand.java | 6 ++++++ src/main/java/duke/command/ListCommand.java | 6 ++++++ src/main/java/duke/command/MarkCommand.java | 7 +++++++ src/main/java/duke/command/TodoCommand.java | 7 +++++++ src/main/java/duke/command/UnmarkCommand.java | 7 +++++++ src/main/java/duke/exception/DukeException.java | 4 ++++ src/main/java/duke/parser/Parser.java | 5 +++++ 13 files changed, 88 insertions(+) diff --git a/src/main/java/duke/Duke.java b/src/main/java/duke/Duke.java index 83391959..abce9797 100644 --- a/src/main/java/duke/Duke.java +++ b/src/main/java/duke/Duke.java @@ -54,6 +54,9 @@ public void run() { } } + /** + * Set the filePath and activate run function. + */ public static void main(String[] args) { new Duke("./data/tasks.txt").run(); } diff --git a/src/main/java/duke/command/ByeCommand.java b/src/main/java/duke/command/ByeCommand.java index 2d31f12e..0239cdfa 100644 --- a/src/main/java/duke/command/ByeCommand.java +++ b/src/main/java/duke/command/ByeCommand.java @@ -15,6 +15,12 @@ public ByeCommand() { isExit = true; } + /** + * Execute user's "bye" command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); System.out.println(" Bye. Hope to see you again soon!"); diff --git a/src/main/java/duke/command/Command.java b/src/main/java/duke/command/Command.java index a9f916aa..a3429807 100644 --- a/src/main/java/duke/command/Command.java +++ b/src/main/java/duke/command/Command.java @@ -17,12 +17,28 @@ public abstract class Command { String keyword; String statement; Boolean isExit = false; + + /** + * Execute a specific user's command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public abstract void execute(TaskList taskList, Ui ui, Storage storage); + /** + * Decide if the user wants to quit. + */ public Boolean isExit() { return isExit; } + /** + * Create a directory "data" if not exists to contain the "tasks.txt". + * @param ui dealing with interactions with the user. + * @param tasks the task list. + * @param storage The storage file of tasks. + */ static void createDirectory(Ui ui, Storage storage, ArrayList tasks) { ui.showLine(); System.out.println(" Seems the data directory doesn't exist yet. Try to create for you!"); diff --git a/src/main/java/duke/command/DeadlineCommand.java b/src/main/java/duke/command/DeadlineCommand.java index 620ccc39..26229465 100644 --- a/src/main/java/duke/command/DeadlineCommand.java +++ b/src/main/java/duke/command/DeadlineCommand.java @@ -15,6 +15,13 @@ public DeadlineCommand(String keyword, String statement) { this.keyword = keyword; this.statement = statement; } + + /** + * Execute user's "deadline" command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); tryAddDeadline(tasks, statement); diff --git a/src/main/java/duke/command/DeleteCommand.java b/src/main/java/duke/command/DeleteCommand.java index 1b385f27..4afa7f71 100644 --- a/src/main/java/duke/command/DeleteCommand.java +++ b/src/main/java/duke/command/DeleteCommand.java @@ -15,6 +15,13 @@ public DeleteCommand(String keyword, String statement) { this.keyword = keyword; this.statement = statement; } + + /** + * Execute user's "delete" command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); tryDeleteTask(tasks, statement); diff --git a/src/main/java/duke/command/EventCommand.java b/src/main/java/duke/command/EventCommand.java index 6c03808a..91996b6b 100644 --- a/src/main/java/duke/command/EventCommand.java +++ b/src/main/java/duke/command/EventCommand.java @@ -14,6 +14,13 @@ public EventCommand(String keyword, String statement) { this.keyword = keyword; this.statement = statement; } + + /** + * Execute user's "event" command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); tryAddEvent(tasks, statement); diff --git a/src/main/java/duke/command/FindCommand.java b/src/main/java/duke/command/FindCommand.java index 5a9ca502..f2673f57 100644 --- a/src/main/java/duke/command/FindCommand.java +++ b/src/main/java/duke/command/FindCommand.java @@ -17,6 +17,12 @@ public FindCommand(String statement) { this.statement = statement; } + /** + * Execute user's "find" command. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ @Override public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); diff --git a/src/main/java/duke/command/ListCommand.java b/src/main/java/duke/command/ListCommand.java index 18b48df1..ab6966a6 100644 --- a/src/main/java/duke/command/ListCommand.java +++ b/src/main/java/duke/command/ListCommand.java @@ -15,6 +15,12 @@ public ListCommand(String keyword, String statement) { this.statement = statement; } + /** + * Execute user's "list" command. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); printTaskList(tasks); diff --git a/src/main/java/duke/command/MarkCommand.java b/src/main/java/duke/command/MarkCommand.java index 52774b94..291be694 100644 --- a/src/main/java/duke/command/MarkCommand.java +++ b/src/main/java/duke/command/MarkCommand.java @@ -16,6 +16,13 @@ public MarkCommand(String keyword, String statement) { this.keyword = keyword; this.statement = statement; } + + /** + * Execute user's "mark" command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); tryMarkTask(tasks, statement); diff --git a/src/main/java/duke/command/TodoCommand.java b/src/main/java/duke/command/TodoCommand.java index 715503eb..ab4a621e 100644 --- a/src/main/java/duke/command/TodoCommand.java +++ b/src/main/java/duke/command/TodoCommand.java @@ -19,6 +19,13 @@ public TodoCommand(String keyword, String statement) { this.keyword = keyword; this.statement = statement; } + + /** + * Execute user's "todoTask" command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); tryAddTodo(tasks, statement); diff --git a/src/main/java/duke/command/UnmarkCommand.java b/src/main/java/duke/command/UnmarkCommand.java index 9e80dec5..43d30dc1 100644 --- a/src/main/java/duke/command/UnmarkCommand.java +++ b/src/main/java/duke/command/UnmarkCommand.java @@ -15,6 +15,13 @@ public UnmarkCommand(String keyword, String statement) { this.keyword = keyword; this.statement = statement; } + + /** + * Execute user's "unmark" command and change the storage file accordingly. + * @param taskList The list containing tasks. + * @param ui dealing with interactions with the user. + * @param storage The storage file of tasks. + */ public void execute(TaskList taskList, Ui ui, Storage storage) { ArrayList tasks = taskList.getTasks(); tryUnmarkTask(tasks, statement); diff --git a/src/main/java/duke/exception/DukeException.java b/src/main/java/duke/exception/DukeException.java index c94af752..a2ddcdd5 100644 --- a/src/main/java/duke/exception/DukeException.java +++ b/src/main/java/duke/exception/DukeException.java @@ -1,5 +1,9 @@ package duke.exception; + +/** + * Exceptions specific to Duke. + */ public class DukeException extends Exception{ } diff --git a/src/main/java/duke/parser/Parser.java b/src/main/java/duke/parser/Parser.java index 5362062a..6bc0a5cf 100644 --- a/src/main/java/duke/parser/Parser.java +++ b/src/main/java/duke/parser/Parser.java @@ -8,6 +8,11 @@ public class Parser { private static String keyword; private static String statement; + + /** + * Parse the user's input into formatted command. + * @param fullCommand a single user's command line. + */ public static Command parse(String fullCommand) throws DukeException { fullCommand = fullCommand.trim(); if (countWithSplit(fullCommand) == 0) throw new DukeException();