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!
For debugging across disparate app, hosts, etc.,x I think the best current option is spans and traces. If you aren’t already familiar, look into general observability, logs/metrics/traces, and definitely opentelemetry!