2010-05-15 61 views
8

¿Hay alguna manera de generar un archivo de documento legible a partir de la documentación del código directamente desde Visual Studio? (También considerando 2010)¿Cómo generar documentación de C# en un archivo CHM o HTML?

Código ejemplo:

/// <summary> 
/// Convert a number to string 
/// </summary> 
/// <param name="number">An integer number to be converted to string</param> 
/// <returns>Number as string</returns> 
/// <example> 
/// <code> 
///  var s = MyMethod(5); 
/// </code> 
/// </example> 
/// <exception cref="Exception">In case it can't convert</exception> 
/// <remarks> 
/// Whatever 
/// </remarks> 
public string MyMethod(int number) 
{ 
    return number.ToString(); 
} 

Respuesta

4

VSdocman puede hacerlo directamente desde Visual Studio.

+1

¡Gran herramienta! Ya funciona con Visual Studio 2010, es muy fácil de usar y genera excelentes documentos. – BrunoLM

9

Uso DocProject. También puede crear documentos HTML CHM. Primero debe instalar Sandcastle.

+0

1 para mí vencer a ella :) –

+0

No está funcionando en mi Windows 7 x64. DocProject simplemente falla todo el tiempo – BrunoLM

+0

¿Es posible en VS2010? – Saint

4

Salida doxygen

+0

+1 para doxygen después de luchar con castillos de arena. IMO Más fácil de usar y con mejores resultados de aspecto – user430788

2
+0

Este es el mejor. Tiene soporte para VS2010, VS2012, VS2013 y probablemente también VS2014 a fin de año. Puede exportar a MS Word, HTML, CHM y otros formatos de Ayuda. –

Cuestiones relacionadas