post icon

Añadir información personalizada en el IntelliSense de Visual Studio para nuestras clases

La herramienta IntelliSense es muy útil en demasiados casos, nos da una ayuda rápida para escribir código. Además de eso nos da una “mini documentación” de lo que representa una clase y que hacen sus métodos, que significa cada parámetro que recibe y cual es su objetivo, que nos retornará el método y muchas otras características nos va ofreciendo.

Cuando nosotros, los desarrolladores vamos creando nuestras clases con sus atributos y métodos, normalmente no documentamos esto y si la solución se vuelve grande con clases y métodos parecidos se complica recordar todo lo que hacen cada una de ellas. Por eso es recomendable agregar estos sumarios o resúmenes de ellos para facilitarnos las cosas en el proceso de vida del desarrollo.

Visual Studio nos ofrece personalizar esto de manera muy sencilla. En Visual Basic.Net y C#.Net se realiza de una manera muy parecida:

/// <summary>
/// Metodo para generar aleatoriamente una cadena de n-caracteres
/// </summary>
''' <summary>
''' Metodo para generar aleatoriamente una cadena de n-caracteres
''' </summary>

También podemos ir agregando información de los parámetros que recibe un método con el tag param name, y el resultado con returns. Supongamos que tenemos el siguiente método:

/// <summary>
/// Metodo demostrativo para www.Devtroce.com
/// </summary>
/// <param name="url">Sitio donde se destrozó el código</param>
/// <param name="usuario">Usuario que destrozó código</param>
/// <returns>Retorna la cadena completa de usuario y sitio</returns>
public string DestrozarCodigo(string url, string usuario)
{
	return "El usuario: " + usuario + " ha destrozado codigo en: " + url;
}

Se verá algo así finalmente:


Comentarios desde Facebook:

Sin Comentarios aun, puedes tú ser el primero en comentar!

Deja tu Comentario

Responder