2010-10-16 22 views
3

我希望能夠用實例化類或訪問字段時intellisense顯示的文本來修飾類和方法。在.Net中,如何用智能提示來裝飾課程?

例如,我想給出使用說明。

我找不到合適的裝飾。我該怎麼做?

+0

此外,在C#中,如果你寫///在短短的功能上面的線,它會自動插入這些標記,上面的函數來完成。它會自動包含參數和返回類型標記(如果有的話) – 2010-10-16 12:19:03

回答

9

只需添加到您的類定義的頂部...

/// <summary> 
/// Returns a pointless string 
/// </summary> 
/// <param name="name">Parameter to personalise the rubbish returned</param> 
/// <returns>Utter junk is returned</returns> 

在哪裏顯示該類描述摘要什麼,因爲它描述了每個參數和返回語句描述了什麼是每一個元素設置了一個param節點回。

+3

除此之外,如果您只在屬性/方法/變量上方的行上鍵入'///',則會添加所有必需的XML標記。 – Bevin 2010-10-16 12:19:47

+0

還有一個問題。如果你說「StringBuilder sb = new」它說「表示...」 - 那個文本的屬性是什麼? – IamIC 2010-10-16 12:26:03

+0

@TomTom是否曾經發生過這樣的情況:文檔的大小是千兆字節,並且必須知道能夠搜索它的正確術語?你覺得我會在看之前發佈這個問題嗎?你爲什麼認爲我們有這樣的教程和支持網站? – IamIC 2010-10-16 17:33:37

0

,我認爲這可以通過使用模型組元

+0

我找到了答案。只需將///註釋添加到類定義的開頭(與構造函數等相反)。 – IamIC 2010-10-16 17:37:59