Sandcastle文档中的图像

时间:2012-03-22 16:32:14

标签: documentation sandcastle

我真的想在Sandcastle生成的程序帮助文件中添加一个图像。

我尽可能地密切关注Sandcastle常见问题解答,但我仍然无法显示图像,尽管我设法让一个小图像占位符出现: Image Placeholder

我很确定图片路径是正确的,因为当我的路径不正确时,会有一个“X”占位符而不是这个占位符。

我尝试将图片的BuildAction设置为Image(默认值)和Content(Sandcastle常见问题解答推荐)。

以下是XML注释的内容:<img scr="art/Image.png"></img>

我觉得我已经尽了一切努力让它发挥作用,图像仍然不会出现。如果有人有任何其他想法或建议,我将非常感激。

1 个答案:

答案 0 :(得分:3)

art目录需要与生成帮助文件的位置相关。通常是html目录。像这样:

[Root]
  \
   [Art]
   |
   [HTML]
   |
   ...

在这种情况下:

/// <summary>Super Great Method</summary>
/// <remarks>A picture: <br />
/// <img src="../art/myImage.jpg" />
/// </remarks>

此讨论也可能对您有用MSDN Discussion

将图像添加到概念性帮助文件时,this method显然有效。