visual-studio - 我可以创建超链接以在 Visual Studio 文件中导航吗？

Question

在设计时，在代码中跳回调用者和反之很有帮助，尤其是当许多文件和窗口已经打开时。

如何在我的代码或注释中创建超链接以在 Visual Studio 文件中导航？例如像这样:

// vs://CallingClassName.cs#methodeName()
// some further comments
Class AService1 {
}

Answer 1

如果您有 VS 2015，则无需任何加载项即可完成。我认为它在早期版本的 VS 中不起作用。只需使用带有链接元素的标准 XML 文档注释: 或 。下面是一个使用多种方法创建链接的示例:

/// <summary>
/// My class description.
/// </summary>
/// <remarks>
/// See <see cref="CallingClassName.methodeName"/> for further details.
/// </remarks>
/// <seealso cref="CallingClassName.methodeName"/>
/// <seealso cref="CallingClassName.methodeName">A method with further details.</seealso>
Class AService1 {
}

如果您只想放置一个没有任何附加注释的链接，我更喜欢 标记，因为它是顶级 XML 注释标记并且不需要父标记，例如

或 .

然后只需右键单击 cref 值并选择“转到定义”或按 F12。您将被导航到正确的代码元素。

作为奖励，当您使用 XML 注释时，您将获得 IntelliSense 描述并且您可以使用 VSdocman 生成类文档。 (我们的产品)或 SandcaSTLe。