2011-08-24 33 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#