C#XML文档网站链接
是否可以在XML文档中包含指向网站的链接? 例如,我的方法总结为
///<Summary> /// This is a math function I found HERE. ///</Summary> public void SomeMathThing(Double[] doubleArray) { ... }
当我键入
SomeMathThing(
我希望IntelliSense显示摘要,并点击“HERE”链接到外部网站。 这可能吗? 怎么做?
尝试:
///<Summary> /// This is a math function I found <see href="http://stackoverflow.com">HERE</see> ///</Summary>
在宣传火车上有点晚,但这是我发现的Visual Studio 2015。
我的示例如下所示:
/// <summary> /// Retrieves information about the specified window. /// The function also retrieves the value at a specified offset into the extra window memory. /// From <see cref="!:https://msdn.microsoft.com/en-us/library/windows/desktop/ms633585(v=vs.85).aspx">this</see> MSDN-Link. /// AHref <a href="http://stackoverflow.com">here</a>. /// see-href <see href="http://stackoverflow.com">here</see>. /// </summary> /// <param name="hwnd"></param> /// <param name="index"></param> /// <returns> /// Testlink in return: <a href="http://stackoverflow.com">here</a> /// </returns> public static IntPtr GetWindowLongPtr(IntPtr hwnd, int index) { return IntPtr.Size == 4 ? GetWindowLongPtr32(hwnd, index) : GetWindowLongPtr64(hwnd, index); }
结果是:
- 工具提示:
- 用!:显示cref-url,但隐藏“this”
- 隐藏ahref-url,但显示文本
- 隐藏seehrefurl和文字
- 对象浏览器:
- 用!:显示cref-url,但隐藏“this”(不可点击)
- 隐藏ahref-url,但显示文本(不可点击)
- 隐藏seehrefurl和文字(不可点击)
- ReSharper (CTRL + SHIFT + F1,命令ReSharper.ReSharper_QuickDoc)
- 用!:隐藏cref-url,但显示“this”(不可点击)
- 现在解释ahref-url(版本从2016年和更新)
- 隐藏seehrefurl和文字(不可点击)
结论:正如Heiner指出的那样,最好的一个是
See <a href="link">this link</a> for more information.
更新 ThomasHagström指出,Resharper现在支持可点击的a-hrefurl。 相应地更新了截图
你可以在cref中包含一个!:前缀,让它在生成的Xml文档中不受影响地传递,这样Innovasys Document! X和Sandcastle将会使用它。 例如
/// <summary> /// This is a math function I found <see cref="!:http://stackoverflow.com">HERE</see> /// </summary>
Visual Studio intellisense将不会显示为intellisense的链接 – 虽然不会太重要,因为它是一个工具提示,所以您无法点击它。
您可以使用标准的HTML语法:
<a href="http://stackoverflow.com">here</a>
文本将在Visual Studio中显示。