¿Hay una herramienta para .NET que genere explicaciones (comentarios) de código si le damos función o manejadores de eventos (como GhostDoc que creemos que no es una buena herramienta)?Herramienta alternativa para un tipo de herramienta GhostDoc
Si comienza un comentario con /// en VS2010, creará parámetros básicos en XML para usted según la función que está comentando.
http://msdn.microsoft.com/en-us/magazine/dd722812.aspx
Así escribir /// antes de la función startMonitor(ManagementScope scope) da ...
/// <summary>
///
/// </summary>
/// <param name="scope"></param>
static void startMonitor(ManagementScope scope)
Si tienes intención de generar la documentación decente a partir de éstos, sugiero https://github.com/EWSoftware/SHFB como su primera parada. Es bastante as.
Eche un vistazo a Sandcastle. Funcionará con Visual Studio 2005 projects. También hay descargas disponibles para nDoc. Tuvo su apogeo alrededor de 2005, pero creo que poco o ningún desarrollo ha tenido lugar desde entonces.
Si está buscando algo que en realidad prellene comentarios de código para usted, no estoy seguro de que pueda hacer mucho mejor que GhostDoc.
Pero va a funcionar para VS2005 – peter
En realidad, /// no genera ninguna documentación, solo etiquetas XML vacías. Donde GhostDoc brilla es en la generación de la documentación de MSDN estilo (incluyendo la verborrea) de forma automática, en base a la información contextual como la propiedad, la clase, la visibilidad, etc. usos
Estas son algunas alternativas verdaderas:
Ahora, cualquier cosa que hagas, por favor, no producen undocumentation! :)
Finalmente, tengo un nombre para el horror que la documentación de MSDN es: "Desorganización". –
¿Habla en serio? ¿Cómo puede una computadora explicar el código? ¡La herramienta que está buscando es el autor del código! –
¡Oye, deja de referirte a los programadores como herramientas! – dotalchemy
no para generar cosas completas ,, para generar el prototipo – peter