2012-05-04 12 views
23

私は機能書く場合:私は「///」と入力してXMLコメントを生成することができます変更されたパラメータを反映するためにVisual StudioでXMLコメントを更新できますか?

public static uint FindAUint(double firstParam) 
    { 

    } 

を、それが与える:

/// <summary> 
    /// *Here I type the summary of the method* 
    /// </summary> 
    /// <param name="firstParam">*Summary of param*</param> 
    /// <returns>*Summary of return*</returns> 
    public static uint FindAUint(double firstParam) 
    { 

    } 

私はその後、私は私の方法を更新する必要があると判断した場合be:

/// <summary> 
    /// *Here I type the summary of the method* 
    /// </summary> 
    /// <param name="firstParam">*Summary of param*</param> 
    /// <returns>*Summary of return*</returns> 
    public static uint FindAUint(double firstParam,double newParam, double newParam2) 
    { 

    } 

新しいスタジオをxmlに追加する方法はありますか?

(私は私は、Visual Studio Expressを使用しています言及する必要があり、私もExpressバージョンで機能を禁止するには、Microsoft過ぎて、それを入れていないだろう)

+0

AFAIK、あなたはただVSを使っているのですか?手動で入力する必要があります –

+4

' qJake

答えて

13

GhostDocをチェックしてください。これは、Visual Studio拡張機能で、XMLコメントを生成します。

+0

既存のコメントを保存し、新しいパラメータにのみXMLを追加しますか? –

+7

存在しないパラメータのコメントを削除し、欠落しているコメントを追加します。 – cadrell0

+0

私はGhostDocとResharperなしでVisual Studioで作業することはできません – jrummell

5

Resharper非常にいいです。 XMLコメントがメソッドのシグネチャと一致しない場合は常に警告を出します。

また、ALTを使用して + は、必要なXMLコメントを削除/追加することによって、これらの不整合を修正することができますキーボードショートカットReSharperのを押します。

+2

私はちょうどこの方法で1つの欠点を参照してください。メソッドにxmlコメントにセクションがない場合、メソッドにパラメータがあっても、Resharperは欠落しているパラメータを追加することを提案しません。しかし、とにかく、+1 :) – Samuel

関連する問題