將URL添加到.NET XML註釋

是否可以將XML註釋添加到方法，以允許其他程序員通過單擊工具提示來跟蹤URL？將URL添加到.NET XML註釋

我曾嘗試將URL添加到使用以下格式的方法（我用看，看看還有標籤也試過）：

/// <summary> 
/// Loads some data. 
/// <a href="http://stackoverflow.com/">click me</a> 
/// </summary> 
/// <param name="id">The id.</param> 
/// <returns>Some Data</returns> 
private string LoadData(int id)

這將產生一個可點擊的超鏈接的URL，然而這隻有在查看原始源代碼時纔有效。如果可能，我希望能夠在懸停在對該方法的調用時顯示的工具提示中單擊並遵循超鏈接，而不是方法本身。

來源

2012-08-29 Walby

我在使用微軟SandCastle文檔生成器的各種論壇上看到了一些建議。 – Walby

如果您在這裏找不到合理的解決方案，則應通過Microsoft Connect網站申請。 – StingyJack

如果可能的話，我想點擊，並按照懸停的方法打電話時顯示在工具提示超鏈接，而不是方法本身的能力。

如果我理解你的問題正確，您希望像下面 enter image description here

顯示的圖像。如果是這樣你的XML註釋是正確的，爲了得到這把光標放在方法和Ctrl + •這是一個短期的ReSharper的得到記錄的方法幫助

更新：下面圖像確認按Ctrl + Q是一個ReSharper的快捷 enter image description here

來源

2012-08-29 15:31:30 HatSoft

我很確定Ctrl + Q不是一個RS快捷鍵。至少，它不在我的安裝中，我也找不到相應的命令。 –

@DanielHilgarth我剛剛暫停了ReSharper並嘗試了Ctrl + Q，但它不起作用 – HatSoft

您能否這樣善良，然後轉到工具 - >選項 - >鍵盤。將光標放在「按快捷鍵：」，按下Ctrl + Q，然後告訴列表中出現的名稱「當前使用的快捷方式：」。非常感謝！ –

沒有像Resharper這樣的花哨工具，工具提示不可點擊，所以沒有辦法做到這一點。

但是，如果引用您的庫的程序員要爲您的代碼點擊「轉到定義」，他們可以在那裏擴展註釋並能夠點擊該URL。

來源

2012-08-29 15:33:02 RobSiklos

感謝您的回覆，但是這對我們的團隊不起作用，因爲我們經常在其他DLL中使用我們沒有源代碼的方法。 – Walby

將URL添加到.NET XML註釋

回答

相關問題