Visual Studio:我能在注释块中添加链接吗?

8
我正在编写软件,经常需要进行图形说明,以解释代码的行为,例如几何图形地说明三角形中从一侧到达撞点的最短距离。

在注释中使用和发明ASCII字符表示法已变得有些乏味,因此我在想,是否可以将绘图程序中创建的图片嵌入项目/解决方案,并在注释块中链接到它们。


这是你要找的吗?https://dev59.com/NWfWa4cB1Zd3GeqPk9Yc。你可以将图像嵌入资源中。 - Rotem Varon
在你可以使用的标记列表中(可在文档注释建议标签(C#编程指南)找到),没有“URL标记”或“图像标记”。除非您具有知道如何解析它的工具,否则您将无法在普通的Visual Studio中找到它。 - Patrick
您可以创建带有图像并包含其URL的最小HTML页面。显然,所有文件都需要映射到共同的网络驱动器上。在VS中Ctrl-单击URL将直接打开HTML页面。 - TaW
你想让链接做什么?你想在哪里显示图片? - John Saunders
2个回答

7
是的,你可以。甚至不需要将图片包含在项目中。VS会自动从任何放置在注释中的URL创建可点击的链接。我建议您将URL放在标准的<see>注释标记内。我们的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() { }

1
如果您在项目中不包含图像,其他团队成员如何查看图像? - Patrick
此外,“see”标签用于表示“成员或字段的引用”。在Visual Studio中,即使只键入文件://-url,您也可以获得到该文件的链接,因此您甚至不需要使用该标签。您如何让Visual Studio在UI中显示该图片? - Patrick
因为see标签不用于此目的。可以验证see标签指向类中特定成员或字段(href无法实现此功能)。这就像使用<para href="url"></para>;你可以这样做,但语义上不正确。在这种情况下,我认为<img />更好,即使它不被支持为“标准注释标记”。 - Patrick
是的,你的工具可以使用它,但我仍然会根据see标记的文档来争辩说你不应该。;-) - Patrick
尽管未被微软明确指定,但<see>也被广泛用于引用外部资源。请参阅Sandcastle http://www.ewoodruff.us/xmlcommentsguide/html/983fed56-321c-4daf-af16-e3169b28ffcd.htm或VSdocman http://www.helixoft.com/files/vsdocman/help/aseelinkxml.htm。 - Peter Macej
显示剩余3条评论

2

ImageComments 扩展程序可在 VS 2010/2012 中显示图像代码。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接