DocNet VS Sandcastle

DocNet

We haven't tracked posts mentioning DocNet yet.
Tracking mentions began in Dec 2020.

Sandcastle

• Net 9.0 LINQ Performance Improvements
  16 projects | news.ycombinator.com | 18 Oct 2024

  Sandcastle Helper File Builder has been around forever and started as an internal MS project IIRC, but for some reason few libraries use it.

  https://github.com/EWSoftware/SHFB

• C# Language extensions
  2 projects | dev.to | 7 May 2023

  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.

• What is the best way to document classes?
  4 projects | /r/csharp | 16 Apr 2023

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

• What the latest tool to generate website docs from /// summary comments?
  2 projects | /r/csharp | 3 Jan 2023

  Sandcastle Helpfile Builder

• Is there a way to get an explanation for an enum value in the context popup menu, similar to the way built-ins have them?
  2 projects | /r/visualbasic | 9 Nov 2022

  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!

• How to document features in a NuGet package
  1 project | /r/AskProgramming | 3 Oct 2022

  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 tool
  1 project | /r/dotnet | 1 Feb 2022
• Code Comments Are Stupid
  1 project | dev.to | 16 Jan 2021

  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.