XML文档问题-Visual Studio 2010 [英] XML documentation problem - Visual Studio 2010

问题描述

你好，
我一直在C#中使用///注释，当我将其构建为XML文件时，无法将其转换为网页.

Hello,
I''ve been using /// comments in C#, and when I build it into an XML file, I cannot convert it into a webpage. Can somebody help me?

推荐答案

如果您还没有这样做，我建议您将XSLT转换从Visual Studio生成的XML文档转换为HTML代码. />
这应该足够简单，因为Visual Studio XML文档格式和输出HTML之间存在一一对应的关系. XML标签，例如typeparam，param，return，seealso等，应作为HTML锚标签出现在输出中.您的HTML页面的行为应类似于在Visual Studio中浏览注释的反射代码，当您在解决方案资源管理器中单击引用时，打开引用并进行浏览.

—SA

If you haven''t done so, I would advise to apply XSLT transformation from Visual Studio generated XML documents to HTML code.

This is should be simple enough as there is one-to-one correspondence between items of Visual Studio XML document format and output HTML. XML tags like typeparam, param, return, seealso, etc. should appear on output as HTML anchor tags. Your HTML page should behave like browsing commented reflected code under Visual Studio, when you click on the reference in the Solution Explorer, open the reference and browse it.

—SA

您好，

有一些产品可以将生成的Visual Studio XML注释文件转换为更人性化的内容.

我最喜欢的是"Sandcastle帮助文件生成器"
http://shfb.codeplex.com/ [ ^ ]

这是入门页面:
http://www.ewoodruff.us/shfbdocs/Index.aspx?topic = html/b772e00e-1705-4062-adb6-774826ce6700.htm [ http://submain.com/products/ghostdoc.aspx [

Hello,

There are a few products that will convert the generated visual studio XML comments file into something more human friendly.

My favourite is "Sandcastle Help File Builder"
http://shfb.codeplex.com/[^]

This is the getting started page:
http://www.ewoodruff.us/shfbdocs/Index.aspx?topic=html/b772e00e-1705-4062-adb6-774826ce6700.htm[^]

Sandcastle projects are compiled by MSBuild so you can integrate them in your solution very easily. You can configure the output to be an MSDN style CHM file or if you prefer a HTML page or even a PDF...

It''s a really cool product. And it''s free!

Valery.
PS: Have you looked at GhostDoc for your XML comments?
http://submain.com/products/ghostdoc.aspx[^]

这篇关于XML文档问题-Visual Studio 2010的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！