Debugging Checklist

The classic \"print-statement-debugging\" techniques may work for simpler cases, but quickly get unmanageable. The checklist below is an extremely effective way to find and fix bugs. Debugging is a learning process - you are about to learn more about your program's behavior and how to translate your ideas into code!

\n
Observe the bug
\n
\"What makes me think there is a problem?\"
\n
\n
Create a reproducible input
\n
\"How can I reliably reproduce this problem?\" You want the smallest, simplest test case possible that reproduces the bug. The smaller it is, the quicker you will be able to debug it.
\n
\n
Narrow the search space
\n
\"\"How can I narrow down to the code that could cause this problem?\" Tracing through the whole program is not feasible. Instead, consider:\n\n\n\n\n\nUsing your intuition as a starting point. Did you change a function recently? Are there any likely culprits?\n\n\n\nPut console.log at significant point of the program so I can see what’s happening. Ideally, I can spot the problematic code is from that. If not, put console.log at places like half way through the code to get closer to the bug.\n\n\n\nConsole logs being truncated. Check if I need everything in the log and maybe split the log into multiple parts.\"\n\nIf you're in GitHub you can use binary search to more easily find the last working version. The explanation is here.
\n
\n
Analyze
\n
\"What information can I gather from this identified code?\" Now use consoles.log so I can mentally follow along. Inspect the values of variables and flow of control, and draw pictures. Try externalizing by writing out what I think should be happening, what is happening, and why it's not happening.
\n
\n
Devise and run experiments
\n
Devise and run experiments. \"How can I check my hypotheses about the issue?\" Make inferences about the root cause and run experiments to validate your hypothesis. Iterate until you identify the root cause.
\n
\n
Modify code to squash the bug
\n
\"How can I fix the issue, and confirm that the fix works?\" The fix should be validated by your experiments and passing the original failed test case. You should be able explain the series of facts, tests, and deductions which match the observed symptom to the root cause and the corrected code.
\n

\n\n

Do not change your code haphazardly. As a scientist, you should change only one variable at a time while experimenting. This ensures you can fully understand the program behavior and causes at every step.
Good style means easier debugging. Anything that helps you navigate and understand your code is key to efficient debugging.\n\n.
Thorough testing helps uncover bugs. You can never reach step 1 if you are unaware of lurking issues!

\n View Source\n

\n \n \n`;\n\n return c.html(html);\n};\n\nconst app = new Hono();\napp.get(\"/\", Debugging_Guide);\nexport default app.fetch;","deleted","label",[98],"permalink","https://www.val.town/x/willthereader/oldDebugging_Guide/code/main.tsx","extension","actionData","errors"]

Debugging Checklist

Observe the bug

Create a reproducible input

Narrow the search space

Analyze

Devise and run experiments

Modify code to squash the bug