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

自作多情 提交于 2019-12-06 18:36:35

问题


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!


回答1:


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




回答2:


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.




回答3:


Another application: VSdocman




回答4:


There's an alternative tool DocFX developed by Microsoft.

It generates API doc in HTML format like this.



来源:https://stackoverflow.com/questions/4304780/what-can-i-do-with-my-xml-documentation

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!