Visual Studio：我可以在注释块中添加链接

Question

我编码软件，我经常需要做图形插图，以解释代码的行为，例如：几何地说明了如何从三角形中的一个边到该三角形中的一个点找到最短距离。

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

Answer 1

是的，你可以。图片甚至不需要包含在项目中。 VS将自动从注释中任何位置的任何URL创建可点击链接。我建议您将网址放在标准内＆lt; see＆gt;评论标签。我们的VSdocman也支持＆lt; img＆gt;标记将直接在生成的文档中显示图片。

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

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

Answer 2

VS 2010/2012的

ImageComments扩展程序允许在代码中显示图像。