2012-05-04 4 views
23

Se scrivo la funzione:È possibile aggiornare un commento XML in Visual Studio per riflettere i parametri che sono stati modificati?

public static uint FindAUint(double firstParam) 
    { 

    } 

posso generare i commenti XML digitando '///', dà:

/// <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) 
    { 

    } 

Se dunque io decido che devo aggiornare il mio metodo per essere:

/// <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) 
    { 

    } 

c'è un modo per ottenere visual Studio per aggiungere le nuove params in XML, senza perdere le descrizioni dei precedenti?

(Devo dire che sto usando Visual Studio Express, io non la metterei passato a Microsoft di non consentire la funzionalità nella versione espresso però)

+0

AFAIK, stai usando solo VS, devi inserirli manualmente –

+4

Se digiti ' qJake

risposta

13

Partenza GhostDoc. È un'estensione di Visual Studio che genererà i tuoi commenti XML per te.

+0

Ciò preserverà i commenti esistenti e aggiungerà solo XML per i nuovi parametri? –

+7

Rimuoverà i commenti per il parametro che non esiste più e ne aggiunge quelli mancanti. non sovrascrive nulla, ma genera anche descrizioni predefinite per metodi, proprietà, parametri, ecc. – cadrell0

+0

Non riesco a lavorare in Visual Studio senza GhostDoc e Resharper. – jrummell

5

Resharper funziona molto bene per me; avvisa ogni volta che il commento XML non corrisponde alla firma di un metodo.

Inoltre, utilizzando il ALT +INVIO scorciatoia da tastiera ReSharper può risolvere queste mancate corrispondenze con l'aggiunta/rimozione di commenti XML necessari.

+2

Ho appena visto uno svantaggio con questo metodo; se il metodo non ha alcuna sezione nei commenti xml, anche se nel metodo ci sono parametri, Resharper non suggerirà di aggiungere i parametri mancanti. Ma in ogni caso, +1 :) – Samuel