Post

Writing documentation tends to be pushed to the bottom of the todo list. With C# we got XML comments that promised automatic reference documentation, but it's rarely used and it provides no solution for high level docs. What would your dream solution look like? (I might be working on something).

Jeroen-bart Engelen

@yeep.bsky.social

9 Jan

I would love an analyser that can spit out a process flow. Like a Mermaid diagram, that documents the logical flow starting from a controller method or something. (I generally build web APIs).

Anders Abel

@anders.abel.nu

That would indeed be cool. I guess it could be done both using reflection and by a compile time analyzer. Sounds like some fun to build.

9/1/26, 9:42 pm0 reposts0 likes

Jeroen-bart Engelen

@yeep.bsky.social

9 Jan

I think the challenge would be the document the worthwhile branches and ignoring others. Some if statements are just pluming to make the code work, not interesting functional choices.