search

se-edu / guides

Style guides and tutorials for SE student projects
MIT License
5 stars 20 forks source link

[AB3: Tracing Code] Breakpoint in main method #33

Open tayruxin opened 2 weeks ago

tayruxin commented 2 weeks ago

Current: image

Problem: Students might not know what to expect after setting a breakpoint at the first statement of the main method.

Proposed: Insert the following paragraph at the end, to show the result of putting a breakpoint in the first statement of the main method:

Upon running the application with the breakpoint in the first statement of the main method, you will realize that the app is launched via this method.

image

damithc commented 1 week ago

hmm... the tutorial doesn't actually ask the reader to put a breakpoint in the main method. It's just a hypothetical statement.

Is there a way to make it clearer (and avoid possible confusion)?

tayruxin commented 6 days ago

Will the following phrasing be better?

Proposed: As you know, the first step of debugging is to place a breakpoint where you want the debugger to pause the execution. For example, if you want to understand how a specific feature of your application works, you might put a breakpoint in the method where that feature is initialized. This is similar to how you would put a breakpoint at the first statement of the main method if you wanted to understand the application's startup process. However, this is just a hypothetical example; you should place breakpoints at points in the code that are relevant to what you're trying to debug.

damithc commented 4 days ago

Proposed: As you know, the first step of debugging is to place a breakpoint where you want the debugger to pause the execution. For example, if you want to understand how a specific feature of your application works, you might put a breakpoint in the method where that feature is initialized. This is similar to how you would put a breakpoint at the first statement of the main method if you wanted to understand the application's startup process. However, this is just a hypothetical example; you should place breakpoints at points in the code that are relevant to what you're trying to debug.

@tayruxin 🤔 hmm... I'm not sure. If we improve the page on debugging (given below) I imagine most students might be OK with the current version without further elaboration.
image

In any case, I took another pass at revising the text in that section. Can you take a look here and share what you think? I revised the content up to the Intellij code search screenshot. image