解释说明VS XML注释插件常见问题
创始人
2024-06-14 00:01:44
0

虽然有许多人对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.  
  4. Class that contains functions to do transformations to help files.  
  5. The source XML is loaded into the  cref="SourceXML"/> property   
  6. (e.g. obj.SourceXML = "XML goes here"). One of   
  7. the associated member functions ( cref="GiveTypeListHTMLHelp"/  
  8. > cref="GiveMemberListHTMLHelp"/>   
  9. cref="GiveMemberHTMLHelp"/>)   
  10. is called to initiate and then return the transformation.  
  11.  
  12.  type="table"> 
  13.  
  14. Help Page 
  15. Function to call 
  16.  
  17. List of Types 
  18. GiveTypeListHTMLHelp 
  19. List of members 
  20. GiveMemberListHTMLHelp 
  21. Help for a single member 
  22. GiveMemberHTMLHelp 
  23.  
  24.  
  25.  
  26.  cref="">public 
  27.  
  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.  
  39.  public class GiveHelpTransforms  
  40.  { 

相关内容

热门资讯

如何允许远程连接到MySQL数... [[277004]]【51CTO.com快译】默认情况下,MySQL服务器仅侦听来自localhos...
如何利用交换机和端口设置来管理... 在网络管理中,总是有些人让管理员头疼。下面我们就将介绍一下一个网管员利用交换机以及端口设置等来进行D...
施耐德电气数据中心整体解决方案... 近日,全球能效管理专家施耐德电气正式启动大型体验活动“能效中国行——2012卡车巡展”,作为该活动的...
20个非常棒的扁平设计免费资源 Apple设备的平面图标PSD免费平板UI 平板UI套件24平图标Freen平板UI套件PSD径向平...
德国电信门户网站可实时显示全球... 德国电信周三推出一个门户网站,直观地实时提供其安装在全球各地的传感器网络检测到的网络攻击状况。该网站...
为啥国人偏爱 Mybatis,... 关于 SQL 和 ORM 的争论,永远都不会终止,我也一直在思考这个问题。昨天又跟群里的小伙伴进行...
《非诚勿扰》红人闫凤娇被曝厕所... 【51CTO.com 综合消息360安全专家提醒说,“闫凤娇”、“非诚勿扰”已经被黑客盯上成为了“木...
2012年第四季度互联网状况报... [[71653]]  北京时间4月25日消息,据国外媒体报道,全球知名的云平台公司Akamai Te...