c# - C＃XML ///コメント、どこにありますかタグが表示されますか？

Question

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

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

では、<returns>タグはどこから入ってくるのでしょうか？

ありがとう。

Answer 1

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

たとえば、次のようなものが表示されます。

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

Answer 2

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

Answer 3

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

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

Answer 4

何かを見つけようとして来るかもしれない人のために。これは最善のアプローチではないかもしれませんが、私見では、メソッド名にカーソルを合わせたときにメソッドが何をするかをより理解しやすくします。

        /// <summary>
        /// Adds a new post given the mapped PostDTO and userId <br></br><br></br>
        /// <b>Returns</b> the newly created object, otherwise null.
        /// </summary>
        /// <param name="postDTO"></param>
        /// <param name="userId"></param>
        PostDTO addPost(PostDTO postDTO, long userId);

このようにして、次の画像のようにVS（少なくともVS 2019）で何かを見ることができます。私の経験では、他の人が作成したコードを理解しようとすると、少なくとも実際のコードか、実際のコードか、それとも何を期待するかを知ることができobjectますnull。シナリオ。

他の人にも役立つといいのですが。

Answer 5

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