我可以将Web链接添加到XML文档中吗?

时间:2016-11-19 18:21:56

标签: .net xml sandcastle xml-documentation

Here我看到了用于生成文档的允许XML标记集(通过SandCastle)。

是否存在链接(到网页)的附加XML标记,当用户按下该链接时,该标记将通过浏览器打开?如果我使用<a href="...:/>,则CHM文件尝试在其窗口中打开链接,我收到脚本错误消息。

1 个答案:

答案 0 :(得分:0)

来自MSDN论坛帖子"Embedding External URLs or Hyperlinks within XML Comments"

  

“要插入外部超链接,请像在html文件中一样。例如,在您的方案中,您可以添加如下信用:”

set_field_buffer
     

“SandCastle等帮助文档工具会正确处理它。”

     

- 用户Chunsheng Tang

所以使用/// <summary> /// This is a test class.See <a href="http://…">Credits</a>. /// </summary> 通常似乎是正确的方法。

不幸的是,你没有确切地说出你正在获得什么样的脚本错误消息。

  • 打开的网页可能只包含错误。如果是这种情况,除了链接到不同的网页之外,您无能为力。

  • 帮助查看器可能会在自己的浏览器中打开网页,其中脚本执行受到限制。在这种情况下,您可以尝试向<a>元素添加target="_blank"属性,以便在新窗口或标签页中打开网页。