2009-12-04 125 views
32

我目前是一名編程專業的學生,​​顯然我的問題很簡單,但我一直無法在網上找到答案。所以在這裏,它是:C#XML ///註釋,<returns></returns> tag顯示了哪裏?

在C#中,在那裏做了<returns>標籤中出現XML ///意見,我知道,包含在<summary>標籤一切都顯示了在智能感知,當你將鼠標懸停在你的方法調用,但而不是返回標籤。

那麼<returns>標籤在哪裏?

謝謝。

回答

26

當你看到在查看方法>>對象瀏覽器

對於例如你會看到這樣的事情:

private int GetColumnIndex(Microsoft.Office.Interop.Excel.Worksheet worksheet, string columnName, int rowIndex, int startColumnIndex) 
    Member of MyAddIn.CommandHandlers.CommandHandler 

Summary: 
Returns the column index with specified name and in specified row 

Parameters: 
worksheet: Target worksheet 
columnName: Column name to find 
rowIndex: Row index in which to search the column 
startColumnIndex: Start index of the column 

Returns: 
The index of column if found, else returns 0 
7

如果生成的評論API文檔,它會在返回值部分,as seen here露面,備註節之前。

7

當您選擇在編譯時構建XML文檔文件時,將XML文檔註釋中包含的所有內容都複製到該文件中。像Sandcastle這樣的程序可以從那裏構建類似於MSDN的HTML文檔。據我所知,它不會在Visual Studio自帶的IntelliSense中顯示。但這不是沒有理由不寫在這裏的:-)。 ReSharper的Ctrl + Q例如確實顯示它。

1

其他部分(基本上任何異常summary)都不會出現在intellisense中。它們僅用於使用類似Sandcastle這樣的工具從XML中生成的文檔中。

+7

這其實並非如此。參數(包括類型參數)在消耗代碼之前輸入參數之前,將顯示爲intellisence。這是一個非常有用的功能,可以幫助您瞭解要在參數中輸入的內容。 – RosieC 2015-11-16 11:49:50

+2

也會顯示註釋拋出的異常,但僅顯示其類型而不顯示關聯的註釋。 – khargoosh 2016-12-15 02:57:36