web-dev-qa-db-ja.com

C＃XML ///コメント、<returns> </ returns>タグはどこに表示されますか？

私は現在プログラミングの学生であり、明らかに私の質問は単純ですが、オンラインでその答えを見つけることができませんでした。だからここにあります：

<returns>タグが表示されるC＃のXML ///コメントでは、メソッド呼び出しの上にマウスを置くと、<summary>タグに含まれるすべてのものがインテリセンスで表示されることはわかっていますが、戻り値タグ。

では、<returns>タグはどこから来るのでしょうか？

ありがとう。

c#xml-comments
44
Alex

[表示] >> [オブジェクトブラウザ]にメソッドが表示されている場合

例：次のようなものが表示されます。

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
32
A9S6

コメントからAPIドキュメントを生成すると、その直前の戻り値セクション ここに表示 に表示されます備考セクション。

7
Fredrik Mörk

コンパイル時にXMLドキュメントファイルを作成することを選択すると、XMLドキュメントコメントに含まれるすべてのものがそのファイルにコピーされます。 Sandcastle のようなプログラムは、そこからMSDNに似たHTMLドキュメントを作成できます。

私の知る限り、VisualStudio独自のIntelliSenseには表示されません。しかし、そこに何かを書かないのは言い訳にはなりません:-)。たとえば、ReSharperのCtrl + Qはそれを表示します。

7
Joey

他のセクション（基本的には例外summary）は、インテリセンスでは表示されません。これらは、 Sandcastle などのツールを使用してXMLから生成されたドキュメントに表示されることのみを目的としています。

1
Richard Szalay