C
C#2y ago
Poller

How do to generate HTML or PDF Docs from Source annotations (summary).

For a Project i look into how i could create a documentation from the annotated source. I found a few solutions, but either theyre not compatible with c# anymore, ore plain dont work. What tools do you know that work in modern .net6 and VS22 for this task?
9 Replies
Johnny
Johnny2y ago
OpenAPI documentation generator?
Poller
Poller2y ago
@Johnny afaik (and what i researched now) it is just for asp.net applications.
Johnny
Johnny2y ago
It is universal - from python to Java you could use it for every project you create
Angius
Angius2y ago
OpenAPI documents the API endpoints, not the code I think Doxygen is used most often
Poller
Poller2y ago
thanks @Angius for confirming. i took a look at doxygen, but it looks like i would have to rework all docs to make it work since it is using another format
Angius
Angius2y ago
You might want to write your own parser lol
Poller
Poller2y ago
i would love too... but i am not allowed 😄
Angius
Angius2y ago
It's possible using Roslyn, you can get the doc comments as well, it's... uh, LeadingTrivia property or some such? Ah, gotcha
Poller
Poller2y ago
it seems like docs are a part of development noone did treally tray to build a up to date product for generating propper documentations. at the moment i am experimenting with sandcastle.. but this also looks like its missing a lot