我正在编写软件,经常需要进行图形说明,以解释代码的行为,例如几何图形地说明三角形中从一侧到达撞点的最短距离。
在注释中使用和发明ASCII字符表示法已变得有些乏味,因此我在想,是否可以将绘图程序中创建的图片嵌入项目/解决方案,并在注释块中链接到它们。
在注释中使用和发明ASCII字符表示法已变得有些乏味,因此我在想,是否可以将绘图程序中创建的图片嵌入项目/解决方案,并在注释块中链接到它们。
这是一个同时使用两种方法的示例。在两种情况下,您都可以在代码编辑器中直接单击链接,图片将显示出来。
/// <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() { }
<para href="url"></para>
;你可以这样做,但语义上不正确。在这种情况下,我认为<img />更好,即使它不被支持为“标准注释标记”。 - Patrick