12
Is there a "markup language" to describe a debugging session? (sh.itjust.works)
submitted 6 months ago by best_username_ever@sh.itjust.works to c/experienced_devs@programming.dev
10 comments fedilink hide all child comments

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!

you are viewing a single comment's thread
view the rest of the comments
[-] best_username_ever@sh.itjust.works 3 points 6 months ago

Why? I got a new job and, for a lot of reasons, it's the first time I'm really motivated by my coworkers. I want to understand this small but relatively complex codebase, and the bookmarks/breakpoints system is not good when you need to discover a lot of topics in a short amount of time (a few months usually when you get a new job).

I'm currently fixing bugs, and while it's going great so far, some bugs are more complex and may require me to understand the whole "flow" of the architecture, but it's different for each bug. I work in the medical field and I have to juggle with a few bugs at the same time before anything is validated, that's why I wanted to take notes of what I deemed interesting while debugging.

Also I often switch branches which explains why breakpoints have to be changed all the time. Breakpoints and Doxygen don't show in a simple way how the code can go from step 1 to step 2 to step 3.

this post was submitted on 17 May 2024
12 points (92.9% liked)

Experienced Devs

3956 readers
1 users here now

A community for discussion amongst professional software developers.

Posts should be relevant to those well into their careers.

For those looking to break into the industry, are hustling for their first job, or have just started their career and are looking for advice, check out:

founded 1 year ago
MODERATORS
snowe@programming.dev
jmk1ng@programming.dev
drewsiferr@programming.dev