2014-10-29 69 views
5

我使用的是编码软件,我经常需要做图形插图来解释代码的行为,例如,从几何上说明了从三角形中的一边到该三角形中的一个碰撞点的最短距离。Visual Studio:我可以在评论块中添加链接

在评论中使用和创建ascii-representation代码变得乏味,所以我想如果可以将绘图(在绘图程序中创建的图片)嵌入到项目/解决方案中,并将它们链接到注释块。

+0

这是你在找什么? http://stackoverflow.com/questions/12181273/adding-url-to-net-xml-comments。您可以将图像作为资源嵌入 – 2014-10-29 19:47:14

+0

您可以使用的标记标记列表中没有“URL标记”或“图像标记”(可在[文档评论推荐标记(C#编程指南)](http:// msdn .microsoft.com/EN-US /库/ 5ast78ax.aspx))。除非你有一个知道如何解析它的工具,否则你不会在普通的Visual Studio中找到它。 – Patrick 2014-10-29 20:39:31

+0

您可以使用图像创建最小的html页面并包含他们的url。显然,所有的文件都需要映射到一个通用的网络驱动器。Ctrl-点击这些URL将在VS中打开html页面。 – TaW 2014-10-29 20:55:04

回答

2

是的,你可以。这些图片甚至不需要包含在项目中。 VS会自动在注释中的任何位置创建一个可点击的链接。我建议您将URL放置在标准<内,请参阅>评论标签。我们的VSdocman也支持<img>标签,它将直接在生成的文档中显示图片。

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

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

其他链接使用Ctl点击这里,图像不起作用,他们只提供下载图像文件.. – TaW 2014-10-29 20:44:36

+1

如果你没有在项目中包括图像,其他团队成员将如何看到图像? – Patrick 2014-10-29 20:47:39

+0

另外,'see'标签用于表示'对成员或字段的引用'。在Visual Studio中,甚至不需要该标记,即使只输入file:// - url,也会获得文件的链接。如何让Visual Studio在UI中显示该图像? – Patrick 2014-10-29 20:51:50

2

ImageComments对于VS 2010/2012的扩展,允许在代码之间显示图像。