C sharp - Documentar código

   
Vista:

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
Valora esta pregunta
Me gusta: Está pregunta es útil y esta claraNo me gusta: Está pregunta no esta clara o no es útil
0
Responder

RE:Documentar código

Publicado por roro (1 intervención) el 07/12/2010 18:26:03
si instancias la clase y ocupas el metodo no aparece????????
Valora esta respuesta
Me gusta: Está respuesta es útil y esta claraNo me gusta: Está respuesta no esta clara o no es útil
0
Comentar

RE:Documentar código

Publicado por Eduardo (19 intervenciones) el 09/12/2010 16:32:22
En efecto, no aparece, solo aparece el encabezado del metodo, pero los remarks y el valor de retorno no aparecen, pero eso sucede incluso en los metodos de clases de .net, es decir, esta bien que no aparescan, mi duda es: si no aparecen ahi, ¿donde los consulto?, en java, el javadoc genera un documento que es accesible con cualquier navegador, pero en c# no se donde ni como consultar los remarks...

saludos y gracias
Valora esta respuesta
Me gusta: Está respuesta es útil y esta claraNo me gusta: Está respuesta no esta clara o no es útil
0
Comentar