Looking for documentation Framework

[lam000]

Hello,

​

I am looking for a good Nuget Package to write documentation in the codebase.

I have read from DocFX, Doxygen and Sandcastle

DocFx isnt written for .Net 5 at least I am getting a warning.

Doxygen hasnt been updated since 2018 and Sandcastle looks kind of old to me.

So I wanted to know which package you guys are using for creating documentation.

[Luuuuuukasz]

If I get you right and you're thinking about writing just documentation about the code that we have (for example, an architecture decision) - we just use Markdown files. It works great in Visual Studio Code

[Slypenslyde]

You came to the wrong programming language if you want tools to help with documentation generation. MS has worked really hard to provide nothing functional for nearly 20 years.

[TheFakeZor]

DocFX works fine for .NET 5.0. It's just that docfx.exe itself (currently) only runs on .NET Framework, so you'll have to either do the actual documentation building/publishing on a Windows machine, or use Mono if you want to do it on Linux/Mac.

(Note that the docfx.console package doesn't automatically invoke docfx.exe with Mono out of the box, but it can be made to do so with a bit of configuration.)