docnet VS Sandcastle

I'm using https://github.com/GowenGit/docnet in production. I use it for text extraction and to generate thumbnails.

An easy to use documentation tool is Sandcastle Help File Builder. Sandcastle can be used as a standalone tool or integrated directly into Visual Studio. After a new language extension is written and tested use Sandcastle to create a help file. The learning curve is short and is unforgiving in that it will report when elements of documentation is missing beginning at class level down to method descriptions and parameter information.

And if you want a standalone help file, you can use Sandcastle Help File Builder in combination with Sandcastle).

Sandcastle Helpfile Builder

1) Make that a habit for all your code. 2) Check the "Create XML documentation" option in your project's build options, 3) Use a tool like Sandcastle Helpfile Builder to automatically create documentation for your projects from these XML and your assemblies. 4) Profit!

XmlDoc comments are the standard way to document C#. In your project settings you'll find an option to generate a documentation file. This option causes the compiler to join all the comments together into a single xml file. You'll want to include that file in your nuget packages because it'll be used to power IDE intellisense when someone installs the package. There are a variety of tools out there that will generate documentation websites from the xmldoc comments. It's been a few years since I used it but Sandcastle Help File Builder used to be my go-to. You can set up your CI pipeline to build and publish the documentation site just like it publishes the nuget package.

Documentation comments also usually hook into documentation generator tools, like DocFX or Sandcastle, which can automatically generate HTML documentation web pages from your documentation comments.