Documentar código
Publicado por Eduardo (19 intervenciones) el 26/11/2010 17:08:15
Hola a todos, decidi comenzar a documentar mi código he hice lo siguiente:
En el menu "Proyecto" seleccione "Propiedades"
En la pestaña "Generar" marque la casilla de "Archivo de documentación XML"
Documente un método
/// <summary>
/// Texto de summary
/// </summary>
/// <remarks>
/// Texto de remarks
/// </remarks>
/// <param name="Parametro">
/// El parametro
/// </param>
/// <returns>
/// true si el archivo existe, false en caso contrario
///</returns>
El menu "Generar" seleccione la opcion "Generar solución"
pues bien, la solución se genero sin problemas, el archivo XML se genero en la ruta que indique y cuando empiezo a escribir una llamada al método documentado me aparece una etiqueta con el encabezado de mi método y el texto que puse en summary, al momento de abrir el parentesis para los argumentos la etiqueta me va mostrando cada argumento que debo listar; hasta aqui todo bien, no hay problema, lo que no se es donde consulto los remarks y el valor de retorno, la etiqueta que menciono hace ver que el método devuelve un bool pero quiero saber como ver el texto que yo puse (true si el archivo existe, false en caso contrario), de antemano muchas gracias y espero que puedan ayudarme.
Saludos
En el menu "Proyecto" seleccione "Propiedades"
En la pestaña "Generar" marque la casilla de "Archivo de documentación XML"
Documente un método
/// <summary>
/// Texto de summary
/// </summary>
/// <remarks>
/// Texto de remarks
/// </remarks>
/// <param name="Parametro">
/// El parametro
/// </param>
/// <returns>
/// true si el archivo existe, false en caso contrario
///</returns>
El menu "Generar" seleccione la opcion "Generar solución"
pues bien, la solución se genero sin problemas, el archivo XML se genero en la ruta que indique y cuando empiezo a escribir una llamada al método documentado me aparece una etiqueta con el encabezado de mi método y el texto que puse en summary, al momento de abrir el parentesis para los argumentos la etiqueta me va mostrando cada argumento que debo listar; hasta aqui todo bien, no hay problema, lo que no se es donde consulto los remarks y el valor de retorno, la etiqueta que menciono hace ver que el método devuelve un bool pero quiero saber como ver el texto que yo puse (true si el archivo existe, false en caso contrario), de antemano muchas gracias y espero que puedan ayudarme.
Saludos
Valora esta pregunta


0