C# xmldoc to documentation page

Question

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.

Unsure about Sandcastle "not being maintained anymore" . Perhaps clone and extend to your needs (and give back to community) :) — EdSF
– EdSF, Commented Aug 7, 2018 at 16:44
Possible duplicate of How to create website from XML documentation comments? — Dan Wilson
– Dan Wilson, Commented Aug 7, 2018 at 16:51
@EdSF, the original is no longer maintained. The fork you linked to is actively maintained, but it seems to be sticking to the original output format of the original project. I wasn't a fan of the original tool and the output it generated. I am always happy to contribute back to the community, but I hate reinventing the wheel, hence my question. — Pete Garafano
– Pete Garafano, Commented Aug 7, 2018 at 17:05

Mel Gerats · Accepted Answer · 2018-08-07 17:58:48Z

2

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.

edited Aug 7, 2018 at 17:58

answered Aug 7, 2018 at 16:49

Mel Gerats

2,2721 gold badge16 silver badges33 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Pete Garafano Over a year ago

Definitely along the lines of what I'm looking for.

Collectives™ on Stack Overflow

C# xmldoc to documentation page

1 Answer 1

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related