VS XML注释插件常见问题是什么

今天小编给大家分享一下VS XML注释插件常见问题是什么的相关知识点，内容详细，逻辑清晰，相信大部分人都还太了解这方面的知识，所以分享这篇文章给大家参考一下，希望大家阅读完这篇文章后有所收获，下面我们一起来了解一下吧。

这些手工标记是非常有用的，如果恰当地设置他们，对导出成外部说明文件将非常有帮助。如果碰到是预先定义的xml标记，编译器可以把这些注释以文本输出；如果是编译器不认识的xml标记，编译器会逐字的把所有内容都输出，这意味着你可以使用自己定义的标记。

适当的设置，C#编译器并不格式化VS XML注释，而是以xml文件输出。下面的步骤将演示如何让C#编译器把VS XML注释输出为xml文件。右键点击解决方案资源管理器中的工程项，打开工程的属性页，点击属性。对话框出现后，点击配置属性目录。点击生成节点。

在右边的框中有输出--xml文档文件，这里就是设置丛VS XML注释生成xml文件的文件名。（注：这里设置的是相对路径，不是绝对路径）。在我的例子中，我使用GiveHelpDoc.xml作为文档名，如果这里没有输入任何值，这将是默认设置。

公认的标记我把VS XML注释标记分类两大类：***类是设置标记，我叫他们主标记。他们在一组标记的开始，而且不会在标记内部出现。第二类是设置标记包含的标记，我叫他们支持标记。支持标记和html标记的区别在于：支持标记采用的是小写，html标记采用的是大写，显示了我将要讨论的支持标记和主标记。

GiveHelpTransforms.cs部分代码：

1. namespace GiveHelp

2. {

3. <remarks>

4. Class that contains functions to do transformations to help files.

5. The source XML is loaded into the <see cref="SourceXML"/> property

6. (e.g. <c><I>objI>.SourceXML = "XML goes here"c>). One of

7. the associated member functions (<see cref="GiveTypeListHTMLHelp"/

8. >, <see cref="GiveMemberListHTMLHelp"/>, <see

9. cref="GiveMemberHTMLHelp"/>)

10. is called to initiate and then return the transformation.

11. <para>

12. <list type="table">

13. <listheader>

14. <term>Help Pageterm>

15. <description>Function to calldescription>

16. listheader>

17. <item><term>List of Typesterm>

18. <description>GiveTypeListHTMLHelpdescription>item>

19. <item><term>List of membersterm>

20. <description>GiveMemberListHTMLHelpdescription>item>

21. <item><term>Help for a single memberterm>

22. <description>GiveMemberHTMLHelpdescription>item>

23. list>

24. para>

25. remarks>

26. <permission cref="">publicpermission>

27. <example><code>

28. // create the class that does translations

29. GiveHelpTransforms ght = new GiveHelpTransforms();

30. // have it load our XML into the SourceXML property

31. ght.LoadXMLFromFile("E:\\Inetpub\\www-

32. root\\GiveHelp\\GiveHelpDoc.xml");

33. // do the translation and then write out the string

34. Response.Write( ght.

35. GiveMemberHTMLHelp(Request.QueryString.Get("Type"),

36. Request.QueryString.Get("Member")) );

37. code>example>

38. public class GiveHelpTransforms

39. {
    

以上就是"VS XML注释插件常见问题是什么"这篇文章的所有内容，感谢各位的阅读！相信大家阅读完这篇文章都有很大的收获，小编每天都会为大家更新不同的知识，如果还想学习更多的知识，请关注行业资讯频道。