2011-08-24 75 views
6

我的问题可能是一个疯狂的想法,但是,当我为教育目的编写代码时,它非常有价值。是否可能将图片插入代码评论?

特别是当代码与数学和物理学科相关时,插入评论中的图像更加方便和清晰。到目前为止,我找不到一种成功地将真实图像插入注释的方法,而不是c#,python或任何其他常见编程语言或IDE。

使用将图像转换为ASCII图像的工具是一种不太精确的解决方法。

任何想法是欣赏

+1

格式化代码使用[LaTeX](http://www.latex-project.org/)提供给学生。用这种方式嵌入有用的图像 – zellio

+0

请参阅http://visualstudiogallery.msdn.microsoft.com/e216ec81-730b-4022-8305-25c39eb1f820 –

+0

在某些情况下,需要将代码直接发送给学生。 Ppt,博客文章或LaTeX格式化的文章对于更多图像来说不是必需的。 –

回答

5

这里有扩展了Visual Studio 2010的编辑为例:Image Insertion(但它绑在Visual Studio中,没有一个通用的解决方案)

+0

感谢simon,当我教C# –

0

我想你使用有关问题的错误的工具。 IDE是一个'开发'环境,所以完全控制样式并不重要。

我会为你的演示文稿使用别的东西(如LaTeX,请参阅评论)。

+0

谢谢@thekip。有时候,代码足以向学生展示。但仅仅为一张图片发布博客或论文会浪费时间。这就是我问这个问题的原因。 –

1

文学编程工具,以这种方式工作;你基本上使用TeX或其他东西来编写代码,然后运行一个预处理程序,将代码片段提取到中间源文件中。 http://en.wikipedia.org/wiki/Literate_programming

+0

感谢@tripleee时,这是一个很好的解决方案。 Woot,我从来不知道文学编程。维基对我来说是一个好的开始。 –

0

为什么不使用免费的图像托管,如http://imgur.com,并插入图片链接代码评论?

那么学生唯一的问题就是从任何IDE复制链接到浏览器的链接。很容易,但。

也许某些IDE有能力“下划线”链接,以便您可以单击它而不是复制副本。

1

每个SHFB项目都是它自己的容器,用于所有文件项目中的。在编译时,(程序项目的)XML文档被拖入SHFB以便放入文档中

如果要在类文档的顶部显示图像,则必须将图像添加到SHFB项目,是指从代码注释的形象见问题2 ...

问题1:

“我不能让图像从使用‘图像’的概念主题展示标签“

  1. 请务必使用与此类似适当的XML标记:

    <section> 
        <content>   
        <mediaLink> 
         <image xlink:href="MyMainImage"/> 
        </mediaLink> 
        </content> 
    </section> 
    
  2. 注意,HREF(以上)没有文件类型关联
    这是因为沙堡希望改为ID

  3. 使用默认媒体文件夹将图像添加到项目。或者,如果您想要,您可以创建自己的文件夹,例如图像。
  4. 转到图片的属性页面,并将生成操作设置为图片。 当您使用“图片”标签时,SHFB仅使用在上面的HREF中看到的属性页面中找到的图片ID
  5. 重新编译项目并打开CHM文件,您将看到 图像。

问题2:

“我不能让影像使用代码注释的编程项目的XML标记,以示”。

  1. 在代码注释的摘要部分,标记可以像这样 :

    /// <summary> 
    /// <remarks><img src="\Images\MyImage.PNG"/></remarks> 
    /// </summary> 
    
  2. 注意src属性确实包含的文件类型。它还必须正确识别SHFB项目对该图像具有的文件夹。

  3. 并称图像的SHFB后右击它和“生成操作”属性更改为内容

快乐编码和记录! 由于去埃里克W.

关键词: SHFB无法添加图片 沙堡帮助文件生成器概念主题图片 代码注释图片 CHM文件中的图像 如何在XML代码添加图像谈到C#