カスタム作成クラスのIntellisenseを取得するには？

Question

「これ」と入力するとあなたは通常、現在のクラスのすべてのルーチン、イベントなどを取得します。長いリストの中の1つを選択せず​​にルーチンの1つを実行するだけでは、通常その隣に説明が表示されます。

どうすればいいですか？ 私は、speed_up（）とbrake（）という2つのルーチンを持つCARというクラスがあるとします。

CAR mycar = new CAR(); 
mycar. 

Answer 1

。 "///"トリプルスラッシュ（XMLコメントとも呼ばれます）を実行すると、ショートカットが実行され、コメントしているクラスまたはメソッドに関する情報を記入できます。説明が表示されたときにあなたがしてインテリセンスのthatsを通じてクラスやメソッドにアクセスすると

そして、これは、このような

/// <summary> 
    /// 
    /// </summary> 
    /// <param name="sender"></param> 
    /// <param name="e"></param> 
    void Method(object sender, EventArgs e) 

として、あなたのコードで表示されます。 ///キー入力によって、あなたの方法に概要を追加

Answer 2

intellisenseに表示されますあなたのクラスとそのメンバー、XML commentsを与える： は、どのように私は彼のタイプは、ときに、2つの機能の説明を参照して私のクラスを使用している人を作ることができます。ビジュアルスタジオでこれを行う最も簡単な方法は、コメントを追加する内容の上に///と入力することです。例えば

：

/// <summary> 
/// Class level summary documentation goes here.</summary> 
/// <remarks> 
/// Longer comments can be associated with a type or member through 
/// the remarks tag.</remarks> 
public class TestClass : TestInterface 
{ 
    /// <summary> 
    /// Store for the name property.</summary> 
    private string _name = null; 

    /// <summary> 
    /// The class constructor. </summary> 
    public TestClass() { } 

    /// <summary> 
    /// Description for SomeMethod.</summary> 
    /// <param name="s"> Parameter description for s goes here.</param> 
    /// <seealso cref="System.String"> 
    /// You can use the cref attribute on any tag to reference a type or member 
    /// and the compiler will check that the reference exists. </seealso> 
    public void SomeMethod(string s) 
    { 
    } 
} 

上記のhereが見出されました。

---

も参照してください：クラスやメソッドではなく、 "//" コメント以上How do you get XML comments to appear in a different project (dll)?

Answer 3

試してみて、

/// <summary> 
/// This is my speed up method 
/// </summary> 
public void speed_up(){ ...} 

下回るように埋めることは意味のインテリセンスで意思が表示されるように、あなたは、メソッドとプロパティごとにこの操作を行うことができます。

Answer 4

あなたの宣言の前の行に///入力し、これにアクセスするには、すべてのタイプの構築物について（すなわち、クラス、メソッド、プロパティ...）

をVisual Studioで利用できるXML文書の形式を使用する必要があります。例えば

：あなたは/// <を入力すると、あなたも発言やexemple のような利用できるXML要素のリストを取得します

/// <summary> 
    /// 
    /// </summary> 
    /// <param name="p"></param> 
    public void Method(string p){... 

：

/// 
    public void Method(string p){... 

次のようなものを取得します詳細については、http://msdn.microsoft.com/en-us/magazine/cc302121.aspx

Answer 5

次のようなコメントを入力できます。

/// <summary> 
/// This sppeds up the car 
/// </summary> 
public void speed_up() 
{ } 

Answer 6

あなたはこのようにそれにコメントを入れてあります。

/// <summary> 
/// This is my function. 
/// </summary> 
/// <param name="myParameter">This parameter is very important.</param> 
/// <returns>It returns always 42.</returns> 
public int MyFunction(string myParameter) 
{ 
    return 42; 
} 

あなたが機能<summary>とPARAMATERS <param name="">の意味の使用法を記述することができます。関数に戻り値がある場合は、タグ<returns>で記述することができます。いくつかのmorタグがサポートされていますが、\の後にあなたのコメントを書くと、visual studioによってリストされます。

Answer 7

メソッドのドキュメントコメントを追加する必要があります。 '///'と入力するか、Visual Studioのアドインを使用して手動で行うことができます。良い命名規則に従うならば、GhostDocを追加することでこれに多くの助けになります。