将URL添加到.NET XML注释

是否可以将XML注释添加到方法，以允许其他程序员通过单击工具提示来跟踪URL？将URL添加到.NET XML注释

我曾尝试将URL添加到使用以下格式的方法（我用看，看看还有标签也试过）：

/// <summary> 
/// Loads some data. 
/// <a href="http://stackoverflow.com/">click me</a> 
/// </summary> 
/// <param name="id">The id.</param> 
/// <returns>Some Data</returns> 
private string LoadData(int id)

这将产生一个可点击的超链接的URL，然而这只有在查看原始源代码时才有效。如果可能，我希望能够在悬停在对该方法的调用时显示的工具提示中单击并遵循超链接，而不是方法本身。

来源

2012-08-29 Walby

我在使用微软SandCastle文档生成器的各种论坛上看到了一些建议。 – Walby

如果您在这里找不到合理的解决方案，则应通过Microsoft Connect网站申请。 – StingyJack

如果可能的话，我想点击，并按照悬停的方法打电话时显示在工具提示超链接，而不是方法本身的能力。

如果我理解你的问题正确，您希望像下面 enter image description here

显示的图像。如果是这样你的XML注释是正确的，为了得到这把光标放在方法和Ctrl + •这是一个短期的ReSharper的得到记录的方法帮助

更新：下面图像确认按Ctrl + Q是一个ReSharper的快捷 enter image description here

来源

2012-08-29 15:31:30 HatSoft

我很确定Ctrl + Q不是一个RS快捷键。至少，它不在我的安装中，我也找不到相应的命令。 –

@DanielHilgarth我刚刚暂停了ReSharper并尝试了Ctrl + Q，但它不起作用 – HatSoft

您能否这样善良，然后转到工具 - >选项 - >键盘。将光标放在“按快捷键：”，按下Ctrl + Q，然后告诉列表中出现的名称“当前使用的快捷方式：”。非常感谢！ –

没有像Resharper这样的花哨工具，工具提示不可点击，所以没有办法做到这一点。

但是，如果引用您的库的程序员要为您的代码点击“转到定义”，他们可以在那里扩展注释并能够点击该URL。

来源

2012-08-29 15:33:02 RobSiklos

感谢您的回复，但是这对我们的团队不起作用，因为我们经常在其他DLL中使用我们没有源代码的方法。 – Walby

将URL添加到.NET XML注释

回答

相关问题