.net - 我可以在 Visual Studio 中的代码块的注释中添加链接吗？

Question

我可以在 Visual Studio 中的代码块的注释中添加链接吗？

例如:

// block 1
class class1
{
}

// block 2
class class2
{
    // review [___class1]
}

[___class1] 是 class1 的链接

提前致谢。

Answer 1

您可以在 Visual Studio 中 bookmark 您的代码，但这存储在您的用户选项文件中，并且通常不会 checkin 源代码管理。我不知道如何从其他代码部分链接到部分代码。

您最好的选择可能是使用文档注释和 <see> 标签:

/// <see cref="Fully.Qualified.Type.Name"/>

但这将仅限于完全限定的位置，即类型、方法、字段和属性。一个特定的 block (例如，一个方法中的 if 语句)是正确的，它只会将该方法的文档/任何内容链接到另一个文档部分，然后只有当您使用像 Sandcastle 这样的工具生成文档时。

您可能会考虑的另一件事，这是一个非常糟糕的 hack，是使用文件超链接，如下所示:

// file://c:/code/file.cs

有一些警告:

您必须使用完整路径名。相对路径不起作用，所以它会被绑定(bind)
直接到您的代码，如果您将源存储库重新映射到另一个则将无法工作
位置

Visual Studio 将在第一个空格处停止，因此文件名或文件夹名中的空格会导致它失败

不能链接到部分代码，只能链接到整个文件。