如何将 C# 文档生成为 CHM 或 HTML 文件?
有没有办法直接从 Visual Studio 中从代码文档生成可读文档文件? (也考虑 2010 年)
代码示例:
/// <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();
}
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();
}
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(4)
使用 DocProject。它可以创建 HTML 文档以及 CHM。您应该首先安装 Sandcastle。
Use DocProject. It can create HTML docs as well CHM. You should install Sandcastle first.
VSdocman 可以直接从 Visual Studio 执行此操作。
VSdocman can do it directly from Visual Studio.
你可以看看 doxygen
You can have a look at doxygen
Sandcastle 帮助文件生成器 是另一个
Sandcastle Help File builder is another one