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

Question

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

例如：

// block 1
class class1
{
}

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

[___class1]是一个指向class1的链接。

提前致谢。

- Homam

---

这是关于 Visual Studio 未来新功能的一个很棒的问题，它会在理解和访问代码方面帮助很多人。例如，我经常在我的代码上做注释，包含伪代码或算法解释，以表明每个代码部分在现实生活中的作用。如果能将每个步骤链接到相应的代码部分，那就非常好了。 - Pedro Emilio Borrego Rached

Answer 1

您可以在Visual Studio中收藏您的代码，但这是存储在您的用户选项文件中，并且通常不会被提交到源代码控制中。我不知道有没有一种方法可以从其他部分链接到代码的某些部分。

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

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

但这只限于完全限定的位置，即类型、方法、字段和属性。一个特定的块（比如，在方法中的一个if语句）是不行的，它只会将该方法/其它内容的文档链接到另一个文档部分，而且只有在使用类似Sandcastle这样的工具生成文档时才能实现。

还有一件事情需要考虑，这是一个非常糟糕的hack，就是使用文件超链接，像这样：

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

需要注意的是：

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

- Randolpho

---

关于文件链接的第二个注意事项（第三条建议）的注释，您只需将链接用双引号括起来，任意数量的空格都可以。 - Adam

微软应该真的加入这个功能，能够从任何代码部分链接到任何代码部分。 - silkfire

考虑在此处应用您的赞成票： https://developercommunity.visualstudio.com/t/Enalble-links-in-comments-that-are-relat/859567?space=8&q=File%3A%3A+link+relative+path - blackboxlogic

Answer 2

如果你正在寻找JS/TS支持，截至2021年5月，VS Code已经添加了对标准JsDoc标记的支持：

https://code.visualstudio.com/updates/v1_57#_jsdoc-link-support

现在这个可以工作了：

@see MyClassName
// or
{@link MyClassName}

如果无法解析符号，请导入它并选择性地禁用eslint：

// eslint-disable-next-line @typescript-eslint/no-unused-vars
import { MyClassName } from "path/to/MyClassName";

/**
* This is an example JSDoc referring to the other class
* @see MyClassName
*/
export const ExampleClass ...

然后可以通过点击并显示上下文弹出窗口。

- chrismarx

---

Python怎么样？ - scūriolus

这个问题最初是针对Visual Studio的。如果想了解关于VS Code的类似问题并且有很好的答案，请参考https://dev59.com/dlcP5IYBdhLWcg3wf6Gb - cachius

Answer 3

这取决于你想要什么 - 你可以只添加URL，VS 将在代码视图中自动将其转换为链接。

当你生成文档时，它是否被转换为链接取决于你使用的工具。

编辑: 好吧，我可能没有理解你的意思。不是非常清楚你想做什么。

如果你想提供一些示例代码，你可以使用 example 标签:

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

您的意思是这样吗？

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

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

- Jon Skeet

---

我相信Homam想要链接到他自己源代码文件中的代码片段。 - Giorgi

我认为他想要将他的代码与其他代码部分以超链接方式链接起来，特别是代码块。 - Randolpho

Answer 4

您可以在注释中放置链接（因为它们只是文件的一部分，就像其他文本一样）。

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

编辑：

如果您想从注释中引用代码的其他部分，则Visual Studio目前不支持此功能。您可以使用{{link1：code documentation}}注释并使用参考标签（例如see），但这仍然无法在IDE中生成超链接。

- Oded

Answer 5

是的，你可以在代码中添加链接，只需这样做

# https://something.something/

要访问链接，请按下控制键并双击链接

- Vamanrao