我可以在评论中将链接添加到Visual Studio中的代码块吗？

Question

我可以在评论中将链接添加到Visual Studio中的代码块吗？

例如：

// block 1
class class1
{
}

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

[___ class1]是class1的链接

提前致谢。

Answer 1

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

您最好的选择可能是使用文档评论和<see>标记：

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

但是这将限于完全合格的位置，即类型，方法，字段和属性。一个特定的块（比如一个方法中的if语句）是正确的，它只会将该方法的文档链接到另一个文档部分，然后只有您可以使用Sandcastle等工具生成文档。

你可能会考虑另外一件事，这是一个非常糟糕的黑客，就是使用文件超链接，如下所示：

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

有警告：

• 您必须使用完整路径名。相对路径不起作用，因此它将被束缚 直接对您的代码，如果您将源存储库重新映射到另一个，则无法工作 位置
• Visual Studio将停在第一个空格处，因此文件名或文件夹名称中的空格将导致其失败
• 您无法链接到部分代码，只能链接到整个文件。

Answer 2

这取决于你想要的 - 你只需添加一个URL，VS就会在代码视图中自动将其转换为链接。

生成文档时是否将其转换为链接取决于您使用的工具。

编辑：好的，我可能错过了你的意思。你正在尝试做的事情并不十分清楚。

如果您想提供一些示例代码，可以使用example标记：

/// <example>
/// Foo f = new Foo();
/// </example>

这是你的意思吗？

您无法链接到特定的代码块，但可以链接到某个成员或类型，例如：

/// <remarks>
/// You can use the <see cref="DoSomething" /> method to do something similar.
/// </remarks>

Answer 3

您始终可以在评论中添加链接（因为它们只是文本，就像文件的其余部分一样）。

取决于IDE如何显示这些内容 - Visual Studio将使其成为可点击的超链接。

修改

如果您想从评论中引用代码的其他部分，则Visual Studio目前不支持此功能。您可以使用引用标记（例如see）使用code documentation注释获得最接近的注释，这仍然不会在IDE中生成超链接。