开发者

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

开发者 https://www.devze.com 2022-12-30 03:48 出处:网络
Is there a way to generate a readable document file from the documentation on the code directly from Visual Studio? (also considering 2010)

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</p开发者_JAVA百科aram>
/// <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();
}


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


VSdocman can do it directly from Visual Studio.


You can have a look at doxygen


Sandcastle Help File builder is another one

0

精彩评论

暂无评论...
验证码 换一张
取 消

关注公众号