开发者

What can I do with my XML documentation? [closed]

开发者 https://www.devze.com 2023-01-27 16:02 出处:网络
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.

We don’t allow questions seeking recommendations for books, tools, software libraries, and m开发者_如何学Pythonore. You can edit the question so it can be answered with facts and citations.

Closed 5 years ago.

Improve this question

I just discover I can generate XML documentation for my project with VisualStudio 2010 with the '///' tags in the code.. It's seems magical but what can I do with that? Is some application exists who can make me a "beautiful doc" with the XML file? Or convert it into a HTML doc?

Thanks a lot for all responses!


There are several apps out there that can take your XML Comments and generate MSDN Style API docs for you (working on the list):

Sandcastle (Microsoft)
NDoc
Live Documenter


There's an alternative tool DocFX developed by Microsoft.

It generates API doc in HTML format like this.


I use GhostDoc to help generate the xml doc comments, and Sandcastle with Sandcastle Help File Builder to turn that into a compiled help file, which looks similar to the MSDN documentation.

You can find a detailed guide to using Sandcastle/Sandcastle Help File Builder here.

I also tried Doxygen and found it to be fairly easy to use, but preferred the look of the documentation that Sandcastle produced.


Another application: VSdocman

0

精彩评论

暂无评论...
验证码 换一张
取 消