visual studio sharp generar documentar documentacion crear codigo clases c# visual-studio-2010 comments

c# - sharp - generar documentacion visual studio 2017



¿Puedo actualizar un comentario XML en Visual Studio para reflejar los parámetros que han cambiado? (2)

Si escribo la función:

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 luego decido que debo actualizar mi método para que sea:

/// <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 alguna manera de que visual studio agregue los nuevos params en el xml sin perder las descripciones de los anteriores?

(Debo mencionar que estoy usando Visual Studio Express; sin embargo, no dejaría pasar a Microsoft para no permitir la función en la versión Express)


Echa un vistazo a GhostDoc . Es una extensión de Visual Studio que generará sus comentarios XML por usted.


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

Además, utilizando el acceso directo ALT + ENTER, el reajuste del atajo de teclado puede corregir estas discrepancias al agregar / eliminar los comentarios XML necesarios.