2012-05-04 20 views
23

Si escribo la función:¿Puedo actualizar un comentario XML en Visual Studio para reflejar los parámetros que han cambiado?

public static uint FindAUint(double firstParam) 
    { 

    } 

puedo generar los comentarios XML escribiendo '///', da:

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

    } 

si yo decido que necesito para actualizar mi método de ser:

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

    } 

¿hay una manera de obtener visual Studio para agregar los nuevos parametros en el XML sin perder las descripciones de las anteriores?

(Debo mencionar que estoy usando Visual Studio Express, yo no lo pondría más allá de Microsoft para no permitir la característica en la versión expreso sin embargo)

+0

AFAIK, si solo está utilizando VS, debe ingresarlos manualmente –

+4

Si escribe ' qJake

Respuesta

13

Salida GhostDoc. Es una extensión de Visual Studio que generará sus comentarios XML por usted.

+0

¿Conservará los comentarios existentes, y solo agregará XML para los nuevos parámetros? –

+7

Eliminará los comentarios para el parámetro que ya no existe y agregará los que falten. no sobrescribe nada. También generará descripciones predeterminadas para métodos, propiedades, parámetros, etc. – cadrell0

+0

No puedo trabajar en Visual Studio sin GhostDoc y Resharper. – jrummell

5

Resharper funciona muy bien para mí; advierte cada vez que el comentario XML no coincide con la firma de un método.

Además, el uso del ALT +ENTER ReSharper combinación de teclas puede corregir estos desajustes mediante la adición/eliminación de los comentarios necesarios XML.

+2

Acabo de ver un inconveniente con este método; si el método no tiene ninguna sección en los comentarios xml, incluso si hay parámetros en el método, Resharper no sugerirá agregar los parámetros faltantes. Pero de todos modos, +1 :) – Samuel

Cuestiones relacionadas