Documentacion con C#

05/01/2005 - 17:25 por Emanuel | Informe spam
Estoy documentado codigo c# con las etiquetas XML que provee el entrono .NET
y los comentarios que escribo dentro de las etiquetas <example> no aparecen
en el pagina web resultante.
Cualquier comentario o documentacion sera de ayuda
Gracias
 

Leer las respuestas

#1 Emanuel
06/01/2005 - 14:03 | Informe spam
gracias

"Jose Luis Manners" wrote:

Emanuel,

Lo primero que necesitas hacer es configurar tu proyecto en VS.NET para que
genere la documentación XML. Esto lo puedes hacer en la ventana de
propiedades del proyecto bajo la pestaña que dice "Build" y donde dice "XML
Documentation File" le indicas el nombre que quieres se le asigne al archivo
XML. Compilas tu proyecto y la documentación XML es generada en el archivo
que indicaste. Ahora puedes tomar ese archivo y lo procesas con NDoc para
generar documentación tipo MSDN, y es este tipo de documentación la que te
muestra el código que pusiste bajo la etiqueta <example>. En otro mensaje
te puse el enlace para descargar NDoc, creo que hay otras herramientas
similares pero yo estoy bastante complacido con esta.

Por cierto, este es un ejemplo de como usar la etiqueta:

/// <summary>
/// The GetZero method.
/// </summary>
/// <example> This sample shows how to call the GetZero method.
/// <code>
/// class MyClass
/// {
/// public static int Main()
/// {
/// return GetZero();
/// }
/// }
/// </code>
/// </example>

Saludos,

Jose Luis Manners, MCP
English: http://blogs.geekdojo.net/jmanners
Español: http://weblogs.golemproject.com/jmanners/

"Encuentra felicidad en tu trabajo o nunca serás feliz."
Cristóbal Colón

"Emanuel" wrote in message
news:
> Estoy documentado codigo c# con las etiquetas XML que provee el entrono
..NET
> y los comentarios que escribo dentro de las etiquetas <example> no
aparecen
> en el pagina web resultante.
> Cualquier comentario o documentacion sera de ayuda
> Gracias
>



Preguntas similares