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

风流意气都作罢 提交于 2020-01-01 03:01:11

问题


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();
}

回答1:


VSdocman can do it directly from Visual Studio.




回答2:


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




回答3:


You can have a look at doxygen




回答4:


Sandcastle Help File builder is another one



来源:https://stackoverflow.com/questions/2838788/how-to-generate-c-sharp-documentation-to-a-chm-or-html-file

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!