What is NDoc?
NDoc is a documentation generator designed for the .NET framework. It processes .NET assemblies and corresponding XML documentation files produced by the C# compiler or compatible tools for VB.NET, enabling developers to create professional-grade class library documentation with ease. The tool supports pluggable documenters, allowing output in diverse formats such as MSDN-style HTML Help files, Visual Studio .NET Help, and web-based documentation.
NDoc encourages extensibility through custom tags and XSLT stylesheets, supporting community-driven enhancements and template sharing. As an open-source solution, NDoc is freely available for download and contribution, making it a practical choice for developers seeking comprehensive, automated .NET documentation aligned with industry standards.
Features
- Multiple Output Formats: Supports MSDN-style HTML Help, Visual Studio .NET Help, and web pages
- Pluggable Documenters: Allows extensibility and support for additional documentation formats
- Custom Tags and Templates: Enables addition and sharing of custom tags using XSLT stylesheets
- Open Source Licensing: Freely available for download and community contributions
- Support for .NET Assemblies: Processes C# and VB.NET documentation XML files
Use Cases
- Generating API documentation for .NET projects
- Creating formatted help files for library distribution
- Publishing web-based documentation for .NET assemblies
- Automating documentation creation for continuous integration workflows
- Using custom templates to align documentation with organizational branding
FAQs
-
What languages does NDoc support for documentation generation?
NDoc processes XML documentation files generated by the C# compiler and compatible tools for VB.NET. -
Can I extend the output format or customize documentation templates in NDoc?
Yes, NDoc supports extensibility through custom tags and XSLT templates, allowing you to tailor documentation to your needs. -
Is NDoc available for free?
Yes, NDoc is open source and freely available for download and community contributions. -
Which output formats does NDoc support?
NDoc can generate documentation in MSDN-style HTML Help (.chm), Visual Studio .NET Help (HTML Help 2), and MSDN-online style web pages.
