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

Question

我正在编写软件,我经常需要做图形插图来解释代码的行为,例如几何地说明如何从三角形中的一个边到该三角形中的一个点找到最短距离.

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

Answer 1

是的你可以。这些图片甚至不需要包含在项目中。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() { }