Sandcastle
A standalone GUI, Visual Studio integration package, and MSBuild tasks for building help files with Sandcastle tools.
What is Sandcastle?
Sandcastle Help File Builder (SHFB) is a toolset that generates comprehensive help files for .NET class libraries by combining XML documentation comments with reflected assembly information. It provides GUI tools, Visual Studio integration, and MSBuild tasks to automate the documentation creation process that was previously handled by command-line Sandcastle tools. The project continues development of the original Microsoft Sandcastle tools which were discontinued in 2012.
.NET developers and technical writers who need to create professional documentation for their class libraries, especially those working in enterprise environments or open-source projects requiring comprehensive API documentation.
SHFB provides a complete, integrated solution for .NET documentation generation that combines the power of Sandcastle with user-friendly interfaces and automation capabilities. Unlike the original command-line Sandcastle tools, it offers project management features, GUI tools, and seamless integration with Visual Studio and build pipelines.
Overview
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.
Use Cases
Best For
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
