Looking for a .NET help file generator tool

Question

0.00/5 (No votes)

See more:

After upgrading our large solution to .NET 4.8, the Sandcastle Help File Builder is throwing all kinds of errors.
The solution now also contains .NET standard and .NET Core projects.
Does anyone know a reliable tool that can generate a help file or PDF from xml comments in C# code in a user friendly way?

What I have tried:

I tried DocFX, but found that too complicated, also tried Dr Explain but that tool does not even know about xml comments.

Posted 27-Sep-22 4:07am

RickZeeland

Updated 27-Sep-22 22:44pm

Add a Solution

Comments

Jo_vb.net 27-Sep-22 13:36pm

wiki has a Comparison:
https://en.wikipedia.org/wiki/Comparison_of_documentation_generators

RickZeeland 27-Sep-22 14:30pm

Thanks!

Member 15627495 28-Sep-22 1:37am

why don't you add as 'package' the .Net version you need ?

Richard Deeming 28-Sep-22 3:55am

SHFB[^] works fine for me with .NET 4.8, .NET Standard, .NET Core, and .NET 5/6/...

Rather than abandon it because of some unspecified errors, why not open an issue or start a discussion in the project? Eric's pretty good at responding there.

RickZeeland 28-Sep-22 4:40am

Posted this as an issue on GitHub and got a response from Eric Woodruff (not related to Bill btw), but by then I already solved the problem by referencing the dll's instead of the project files.
So thanks for all the suggestions everyone!

1 solution

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

RickZeeland · Accepted Answer · 2022-09-27T22:44:00

Solution 1

Solved the problem in Sandcastle Help File Builder by referencing the dll's instead of the project files. Having all dll's in the same place seemed to help too.

Posted 27-Sep-22 22:44pm

RickZeeland