Visual Studioの関数についてIntelliSenseにコメントを追加するにはどうすればよいですか？

Visual StudioとC＃では、ToString（）などの組み込み関数を使用すると、IntelliSenseはその機能を説明する黄色のボックスを表示します。

作成した関数とプロパティにどのように設定できますか？

関数の説明と関数の各パラメーターを指定できる領域を生成するには、関数の前の行に次のように入力して、を押しますEnter。

• C＃： ///

• VB： '''

参照ドキュメントコメント用の推奨タグ（C＃プログラミングガイド）を使用すると、これらのコメントに含めることができる構造化コンテンツに関する詳しい情報は。

必要なのはxmlコメントです。基本的には、次の構文に従います（Solmeadによって漠然と説明されています）。

C＃

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

<c>text</c>-コードとして示したいテキスト。
< c >タグは、説明内のテキストをコードとしてマークする必要があることを示す方法を提供します。< code >を使用して、複数の行をコードとして示します。

<code>content</code>-コードとしてマークするテキスト。
< code >タグは、複数の行をコードとして示す方法を提供します。< c >を使用して、説明内のテキストをコードとしてマークする必要があることを示します。

<example>description</example>-コードサンプルの説明。
< example >タグでは、メソッドまたはその他のライブラリメンバーの使用方法の例を指定できます。これには通常、< code >タグの使用が含まれます。

<exception cref="member">description</exception>-例外の説明。
< exception >タグを使用すると、スローできる例外を指定できます。このタグは、メソッド、プロパティ、イベント、およびインデクサーの定義に適用できます。

<include file='filename' path='tagpath[@name="id"]' />
< include >タグを使用すると、ソースコードの型とメンバーを説明する別のファイルのコメントを参照できます。これは、ソースコードファイルにドキュメンテーションコメントを直接配置する代わりになります。ドキュメントを別のファイルに配置することで、ソースコードとは別にドキュメントにソース管理を適用できます。1人がソースコードファイルをチェックアウトし、他の1人がドキュメントファイルをチェックアウトできます。< include >タグは、XML XPath構文を使用します。< include >の使用をカスタマイズする方法については、XPathのドキュメントを参照してください。

<list type="bullet" | "number" | "table">
    <listheader>
        <term>term</term>
        <description>description</description>
    </listheader>
    <item>
        <term>term</term>
        <description>description</description>
    </item>
</list>

< listheader >ブロックは、テーブルまたは定義リストのいずれかの見出し行を定義するために使用されます。テーブルを定義するときは、見出しに用語のエントリを指定するだけで済みます。リスト内の各アイテムは、< item >ブロックで指定されます。定義リストを作成するときは、用語と説明の両方を指定する必要があります。ただし、テーブル、箇条書き、または番号付きリストの場合は、説明のエントリを指定するだけで済みます。リストまたはテーブルには、必要な数の< item >ブロックを含めることができます。

<para>content</para>
< para >タグは、< summary >、< remarks >、< returns > などのタグ内で使用するためのもので、テキストに構造を追加できます。

<param name="name">description</param>
< param >タグは、メソッドのパラメーターの1つを説明するメソッド宣言のコメントで使用する必要があります。複数のパラメーターを文書化するには、複数の< param >タグを使用します。
< param >タグのテキストは、IntelliSense、オブジェクトブラウザー、およびコードコメントWebレポートに表示されます。

<paramref name="name"/>
< paramref >タグは、コードのコメント内の単語（たとえば、< summary >または< remarks >ブロック内）がパラメーターを参照することを示す方法を提供します。XMLファイルを処理して、太字フォントや斜体フォントなど、いくつかの明確な方法でこの単語をフォーマットできます。

< permission cref="member">description</permission>
< 許可 >タグを使用すると、メンバーのアクセスを文書化することができます。PermissionSetクラスを使用すると、メンバーへのアクセスを指定できます。

<remarks>description</remarks>
< remarks >タグは、タイプに関する情報を追加するために使用され、< summary >で指定された情報を補足します。この情報は、オブジェクトブラウザに表示されます。

<returns>description</returns>
< リターン >タグは、戻り値を記述するためのメソッド宣言にコメントに使用されるべきです。

<see cref="member"/>
< see >タグを使用すると、テキスト内からリンクを指定できます。< seealso >を使用して、テキストを[関連項目]セクションに配置することを示します。cref属性を使用して、コード要素のドキュメントページへの内部ハイパーリンクを作成します。

<seealso cref="member"/>
< seealso >タグを使用すると、[参照]セクションに表示するテキストを指定できます。< see >を使用して、テキスト内からリンクを指定します。

<summary>description</summary>
タイプまたはタイプメンバーを説明するには、 < summary >タグを使用する必要があります。< remarks >を使用して、型の説明に補足情報を追加します。Sandcastleなどのドキュメントツールがコード要素のドキュメントページへの内部ハイパーリンクを作成できるようにするには、cref属性を使用します。< summary >タグのテキストは、IntelliSenseのタイプに関する情報の唯一のソースであり、オブジェクトブラウザーにも表示されます。

<typeparam name="name">description</typeparam>
< typeparam >タグは、型パラメーターを説明するジェネリック型またはメソッド宣言のコメントで使用する必要があります。ジェネリック型またはメソッドの型パラメーターごとにタグを追加します。< typeparam >タグのテキストは、オブジェクトブラウザーのコードコメントWebレポートであるIntelliSenseに表示されます。

<typeparamref name="name"/>
このタグを使用して、ドキュメントファイルの利用者が単語をイタリックなどの異なる方法でフォーマットできるようにします。

<value>property-description</value>
< value >タグを使用すると、プロパティが表す値を記述できます。Visual Studio .NET開発環境のコードウィザードでプロパティを追加すると、新しいプロパティの< summary >タグが追加されることに注意してください。次に、プロパティが表す値を記述する< value >タグを手動で追加する必要があります。

このようにXMLコメントを行う

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

///を使用してコメントの各行を開始し、コメントにメタデータリーダーの適切なxmlを含めます。

///<summary>
/// this method says hello
///</summary>
public void SayHello();

個人的には、これらのコメントは、消費者がコードを読み取ることができないクラスを開発しているのでない限り、通常は見当違いであると思います。

それらはXMLコメントと呼ばれます。彼らは永遠にVisual Studioの一部となっています。

XML-docコメントを生成するVisual Studio用の無料のアドインであるGhostDocを使用すると、ドキュメント作成プロセスを簡単にすることができます。文書化するメソッド/プロパティにキャレットを置き、Ctrl-Shift-Dを押すだけです。

これが私の投稿の例です。

それが役に立てば幸い:)

CSharpでは、Parmsを使用してメソッド/関数のアウトラインを作成する場合、3つのスラッシュを追加すると、サマリーとparmsセクションが自動生成されます。

だから私は入れました：

public string myMethod(string sImput1, int iInput2)
{
}

次に、3つの///をその前に配置すると、Visual Studioから次のようになります。

/// <summary>
/// 
/// </summary>
/// <param name="sImput1"></param>
/// <param name="iInput2"></param>
/// <returns></returns>
public string myMethod(string sImput1, int iInput2)
{
}

このようなメソッドを定義すると、必要なヘルプが得られます。

    /// <summary>
    /// Adds two numbers and returns the result
    /// </summary>
    /// <param name="first">first number to add</param>
    /// <param name="second">second number to </param>
    /// <returns></returns>
    private int Add(int first, int second)
    {
        return first + second;
    }

コード使用のスクリーンショット

http://msdn.microsoft.com/en-us/library/3260k4x7.aspxをお読みください。コメントを指定するだけでは、インテリセンスのヘルプコメントは表示されません。

これらすべての他の答えは理にかなっていますが、不完全です。Visual StudioはXMLコメントを処理しますが、それらをオンにする必要があります。これを行う方法は次のとおりです。

Intellisenseは、ソースコードに入力したXMLコメントを使用しますが、Visual Studioオプションで有効にする必要があります。へ行きますTools> Options> Text Editor。Visual Basicの場合、Advanced> Generate XML documentation comments for '''設定を有効にします。C＃の場合、Advanced> Generate XML documentation comments for ///設定を有効にします。入力時にIntellisenseは要約コメントを使用します。参照プロジェクトがコンパイルされた後、他のプロジェクトから利用できるようになります。

作成するには、外部のドキュメントを、あなたはを通してXMLファイルを生成する必要がありますProject Settings> Build> XML documentation file:コンパイラの制御パス/docオプションを選択します。XMLファイルを入力として受け取り、選択した出力形式でドキュメントを生成する外部ツールが必要です。

XMLファイルを生成すると、コンパイル時間が著しく増加する可能性があることに注意してください。

また、Visual Studioアドインゴーストドキュメントは、関数名からヘッダーコメントを作成して埋めようとします。

ソルミードは正解です。詳細については、XMLコメントを参照してください。