2014-10-29 70 views
5

我使用的是編碼軟件,我經常需要做圖形插圖來解釋代碼的行爲,例如,從幾何上說明了從三角形中的一邊到該三角形中的一個碰撞點的最短距離。Visual Studio:我可以在評論塊中添加鏈接

在評論中使用和創建ascii-representation代碼變得乏味,所以我想如果可以將繪圖(在繪圖程序中創建的圖片)嵌入到項目/解決方案中,並將它們鏈接到註釋塊。

+0

這是你在找什麼? http://stackoverflow.com/questions/12181273/adding-url-to-net-xml-comments。您可以將圖像作爲資源嵌入 – 2014-10-29 19:47:14

+0

您可以使用的標記標記列表中沒有「URL標記」或「圖像標記」(可在[文檔評論推薦標記(C#編程指南)](http:// msdn .microsoft.com/EN-US /庫/ 5ast78ax.aspx))。除非你有一個知道如何解析它的工具,否則你不會在普通的Visual Studio中找到它。 – Patrick 2014-10-29 20:39:31

+0

您可以使用圖像創建最小的html頁面幷包含他們的url。顯然,所有的文件都需要映射到一個通用的網絡驅動器。Ctrl-點擊這些URL將在VS中打開html頁面。 – TaW 2014-10-29 20:55:04

回答

2

是的,你可以。這些圖片甚至不需要包含在項目中。 VS會自動在註釋中的任何位置創建一個可點擊的鏈接。我建議您將URL放置在標準<內,請參閱>評論標籤。我們的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() { } 
+0

其他鏈接使用Ctl點擊這裏,圖像不起作用,他們只提供下載圖像文件.. – TaW 2014-10-29 20:44:36

+1

如果你沒有在項目中包括圖像,其他團隊成員將如何看到圖像? – Patrick 2014-10-29 20:47:39

+0

另外,'see'標籤用於表示'對成員或字段的引用'。在Visual Studio中,甚至不需要該標記,即使只輸入file:// - url,也會獲得文件的鏈接。如何讓Visual Studio在UI中顯示該圖像? – Patrick 2014-10-29 20:51:50

2

ImageComments對於VS 2010/2012的擴展,允許在代碼之間顯示圖像。