Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to generate C# documentation to a CHM or HTML file?

Is there a way to generate a readable document file from the documentation on the code directly from Visual Studio? (also considering 2010)

Code example:

/// <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();
}
like image 438
BrunoLM Avatar asked May 15 '10 03:05

BrunoLM


1 Answers

Use DocProject. It can create HTML docs as well CHM. You should install Sandcastle first.

like image 55
Fernando Avatar answered Sep 28 '22 17:09

Fernando