A quien no le ha pasado que muchas veces le toca revisar el código de otra persona y no se entera de nada... es más debo de reconocer que a mi me ha pasado que hubo momentos en que no reconocía que hacia mi propio código xD, pero esto son cosas del pasado y que uno va aprendiendo a punta de collejas =)...
Yo sé que es una tarea tediosa, pero felizmente hay herramientas que nos facilitan la vida como GhostDoc, una herramienta que permite generar documentación de tus clases y métodos con solo apretar una combinación de teclas ...claro que tienes que seguir algunas reglas para que la documentación generada sea coherente.
Te pide que pongas tu email, lo pones y a descargar. Una vez descargado, descomprimes el archivo y ejecutas el exe que hay dentro para empezar la instalación. Una vez finalizada la instalación cuando abras el Visual Studio ( en mi caso la versión 2010) te saldrá la siguiente ventana ...
Esta ventana te da la opción de elegir la combinación de teclas que pulsarás cuando quieras generar la documentación de un método, propiedad, cabecera de clase, etc, etc .... con GhostDoc, si se fijan por defecto la combinación de teclas asignadas es Ctrl+Shift+D, yo estoy acostumbrado a usar esta pero si no te gusta pues eliges otra opción de la lista desplegable y pulsas el boton Assign o si no te apetece configurarlo en este momento le das a Skip.
Luego de esto te pregunta si quieres crear una nueva configuración, como es la primera vez que la instalo en este ordenador le doy a crear.
Y listo ya tenemos instalado GhostDoc en nuestro VS =) !
Ahora probemos en el código. Como ejemplo vamos a crear una clase 'Customer' con un par de propiedades y un método, que sería algo como esto:
public class Customer
{
public int Id { get; set; }
public string Name { get; set; }
public void SaveCustomer(int customerId, string customerName)
{
//blablabla
}
}
Ahora seleccionamos la propiedad Id y presionamos Ctrl+Shift+D y veamos el resultado:
///
/// Gets or sets the id.
///
///
/// The id.
///
public int Id { get; set; }
Lo mismo hacemos con la propiedad Name y el método SaveCustomer, recuerda que tienes que seleccionar completamente el nombre de la propiedad ó metodo y pulsar Ctrl+Shift+D. Al final el resultado sería el siguiente:
public class Customer
{
///
/// Gets or sets the id.
///
///
/// The id.
///
public int Id { get; set; }
///
/// Gets or sets the name.
///
///
/// The name.
///
public string Name { get; set; }
///
/// Saves the customer.
///
/// The customer id.
/// Name of the customer.
public void SaveCustomer(int customerId, string customerName)
{
//blablabla
}
}
Como puedes ver, hasta documenta tambien los parámetros de un método. La regla principal para que la documentación generada sea coherente es que el nombre del metodo sea un verbo o un verbo seguido de un sustantivo y la propiedad un nombre válido. La documentación que genera GhostDoc por defecto es en inglés, aunque existen extensiones para generar documentación en español e italiano aunque no son tan completas como en inglés. Espero les sea útil, hasta la próxima =) !!
Un saludo,
Jhon Marmolejo
