Creating documentation in C# using visual studio and sandcastle

Question

0.00/5 (No votes)

See more:

Whats the update on documentation for VS projects. Is Sand Castle still the norm, or is there another better tool out there for documentation?

Posted 21-Apr-16 0:38am

.net developer123456789

Updated 9-May-16 5:37am

F-ES Sitecore

v2

Add a Solution

2 solutions

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 · Answer 1 · 2016-04-21T01:17:00

Of the free solutions available for me Sand Castle is the norm, I can recommend Sandcastle Help File Builder:
GitHub - EWSoftware/SHFB: Sandcastle Help File Builder (SHFB). A standalone GUI, Visual Studio integration package, and MSBuild tasks providing full configuration and extensibility for building help files with the Sandcastle tools.[^]

In the past I used NDoc which was nice but sadly not regularly updated for newer .NET Framework versions.
HelpNDoc seemed promising, but didn't succesfully generate documentation for a large solution:
HelpNDoc | HTML help authoring tool, Word, PDF and eBook documentation generator[^]

Dmitriy Gakh · Answer 2 · 2016-05-09T05:37:00

For now I selected two tools to use for documenting and commenting code in my projects in Visual Studio 2015 - Sandcastle and GhostDoc.

Sandcastle is continuously developing and is quite powerful tool. It is free and open source. I think frequent code commits is an evidence of its actuality.

GhostDoc can help to make XML comments.

Creating documentation in C# using visual studio and sandcastle

2 solutions

Solution 1

Solution 2

Add your solution here

Preview 0