c# - Visual Studio : Can I add links in comment blocks

Question

我在编码软件，我经常需要做图形说明来解释代码的行为，例如从几何上说明如何找到从三角形中的一条边到该三角形中的命中点的最短距离。

在评论中使用和发明 ascii 表示有点乏味，所以我在想是否可以将绘图(在绘图程序中创建的图片)嵌入到项目/解决方案中并在评论中链接到它们- block 。

Answer 1

是的，你可以。图片甚至不需要包含在项目中。 VS 将自动从放置在评论中任何位置的任何 URL 创建一个可点击的链接。我建议您将 URL 放在标准的 评论标签中。我们的 VSdocman还支持将在生成的文档中直接显示图片的 标签。

这是使用这两种方式的示例。在这两种情况下，您都可以直接在代码编辑器中单击链接，图片就会显示出来。

/// <summary>
/// Click <see href="file:///C:\Pictures\Desert.jpg">here</see> to See the picture.
/// </summary>
/// <remarks>Here is the embedded picture:
/// <img src="file:///C:\Pictures\Desert.jpg"/>
/// </remarks>
public void Method1() { }