I want to document my debugging sessions in a text file but I don’t know if anyone did this before.

I came up with this kind of “language” that is a mix between Markdown and C++, but I still wonder if something equivalent exists already.

// When you click on the button
# [click button]
- A::f()
// - ... other method calls, don't document if you don't need to

# A::f()
// "..." for "parameters" where you don't need the details
- Stuff::g(...)
- Stuff::h(...)

// <Class> is a fake template thing to show the possible types of an object
# <SubStuffA | SubStuffB> Stuff::g(...)
- Stuff::g() {} // empty but I use v/=> for virtual call
  v/=> SubStuffA::g()
  v/=> SubStuffB::g()

# SubStuffA::g()

# SubStuffB::g()

# Stuff::h(...)

I document methods in the order of appearance in the code.

If you have any good idea about a reliable way to document a list of function calls, I’m interested!

  • 0x1C3B00DA@fedia.io
    link
    fedilink
    arrow-up
    3
    ·
    7 months ago

    I could see walking through a debug session document with a junior dev to guide them on how to debug classes of issues better. Or if they’re running into a bug and ask for your help, you could write out the first few debugging steps and let them take it from there. That might be easier to understand than “I’d check service X and see if it’s processing Y like it should or just passing it on to Z”. Having a defined way to explain how to debug an issue could be useful