CODEWITHSUNDEEP
c#xml-documentation
Pete Garafano
Pete Garafano

Reputation: 4923

C# xmldoc to documentation page

I've been using Swagger recently for a WebAPI project, and I like the documentation and its inclusion of the XML Documentation I put on my methods. I have various other non-WebAPI project that I'd like to generate documentation for. I know sandcastle exists, and I've used it previously, but it isn't maintained anymore. There is a fork that is maintained (the fork doesn't appear to be much of a change over the original). Additionally, it isn't the "prettiest" thing on the planet to use (or what it generates). Previously I used the output and Google promptly down-ranked me for not supporting mobile content.

Are there any other documentation generators that make modern websites that scale nicely on a desktop and mobile devices? Am I just relegated to making the documentation manually?

This is similar to How to create website from XML documentation comments?, however, that is four years old and as we all know, a lot of changes in technology in 4 years. I'm looking for current information.

Upvotes: 0

Views: 83

Answers (1)

Mel Gerats
Mel Gerats

Reputation: 2252

DocFX makes it very easy to combine generated and manual documentation

https://dotnet.github.io/docfx/

It was developed by Microsoft for the replacement of the MSDN documentation portal, and made open source.

Upvotes: 2

Related Questions