c＃實現在設計時使用dll上下文幫助

Question

我在c＃中開發了一些dll庫文件;現在我需要知道是否有在我的項目中插入上下文幫助，將在一個設計時的作品顯示，當客戶將調用可見的方法和我的媒體庫的事件，如截圖在此鏈接

Click here for full image的可能性

可以做到這一點嗎？一些想法？非常感謝大家

通過Jumpier

Answer 1

該文檔是使用xml comments在代碼中創建的。

/// <summary> 
/// This text will show up in the contextual help box. 
/// </summary> 
public void SomePublicMethod() { 
    ... 
} 

要運送帶有此元數據的dll，generate xml documentation。

爲Visual C＃項目生成XML文檔文件 在解決方案資源管理器中，在項目菜單上選擇項目，單擊屬性。 單擊生成選項卡。 在生成頁面上，選擇XML文檔文件。默認情況下，該文件是在指定的輸出路徑下創建的，例如「bin \ Debug \ Projectname.XML」。

Answer 2

它被稱爲XML Docs。這是基本的語法。

/// <summary> 
/// This class performs an important function. 
/// </summary> 
public class MyClass{ } 

• XML Documentation Comments
• Recommended Tags

Answer 3

你需要XML代碼註釋添加到您的類，屬性和方法。 構建應用程序時，請檢查Xml文檔文件的Build選項。 然後，您將您的DLL分發xml文件。

在Visual Studio中，在任何代碼元素（類，屬性，枚舉，方法）和適當的評論存根將被添加之前，在行上鍵入///。