我可以创建超链接以在Visual Studio文件中导航吗?

时间:2015-11-02 12:35:10

标签: visual-studio hyperlink

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

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

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

1 个答案:

答案 0 :(得分:4)

如果你有VS 2015,你可以在没有任何插件的情况下完成。我认为它在早期版本的VS中不起作用。只需使用包含链接元素的标准XML文档注释:< see>或者< seealso>。以下是创建链接的多种方式的示例:

/// <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 {
}

如果您只想放置一个没有任何其他评论的链接,我希望&lt; seealso&gt; tag,因为它是顶级XML注释标记,并且不需要父级,例如&lt; summary&gt;或&lt; remarks&gt;。

然后右键单击cref值并选择“Go To Definition”或按F12。您将被导航到正确的代码元素。

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