解释说明VS XML注释插件常见问题

开发 后端
VS XML注释并不很直观,因此,我从来不使用include。但是如果你的VS XML注释太长的话,你可以权衡一下。 include的几个用于指定外部文件的属性是必需的。

虽然有许多人对VS XML注释的插件表示怀疑,但在年复一年的不断发展中,他的插件问题也在不断提高。保障VS XML注释的插件稳定运行是完全有可能的,但前提是要深入理解到底什么是VS XML注释,及他是怎么运作的。

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

适当的设置,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>obj</I>.SourceXML = "<I>XML goes here</I>"</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 Page</term> 
  15. <description>Function to call</description> 
  16. </listheader> 
  17. <item><term>List of Types</term> 
  18. <description>GiveTypeListHTMLHelp</description></item> 
  19. <item><term>List of members</term> 
  20. <description>GiveMemberListHTMLHelp</description></item> 
  21. <item><term>Help for a single member</term> 
  22. <description>GiveMemberHTMLHelp</description></item> 
  23. </list> 
  24. </para> 
  25. </remarks> 
  26. <permission cref="">public</permission> 
  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.     
  34. // do the translation and then write out the string  
  35. Response.Write( ght.  
  36. GiveMemberHTMLHelp(Request.QueryString.Get("Type"),  
  37. Request.QueryString.Get("Member")) );  
  38. </code></example> 
  39.  public class GiveHelpTransforms  
  40.  { 
责任编辑:chenqingxiang 来源: Linux论坛
相关推荐

2009-12-03 15:21:24

2009-12-04 09:51:32

VS XML注释

2009-02-17 23:41:43

Mplayer播放器常见问题

2011-04-01 13:55:24

Java

2011-05-06 15:39:55

硒鼓

2013-11-14 15:47:29

SDN问题答疑

2010-07-21 09:10:02

Perl常见问题

2009-12-14 09:09:35

VS 2008 Pro

2009-11-25 11:25:31

VS2003软件

2011-02-22 14:00:16

vsftpd

2010-03-25 09:08:43

CentOS配置

2010-05-13 13:27:23

2009-11-02 17:25:04

ADSL常见问题

2009-09-22 09:22:03

.NET常见问题

2010-04-14 14:37:56

Oracle卸载

2009-12-31 09:58:51

Ubuntu常见问题

2011-03-29 13:23:54

CACTI

2010-07-21 09:16:47

Perl常见问题

2013-08-13 13:16:02

Android adb问题

2012-02-06 10:37:07

Java
点赞
收藏

51CTO技术栈公众号