如何将 C# 文档生成为 CHM 或 HTML 文件?

发布于 2024-09-01 07:00:01 字数 620 浏览 4 评论 0原文

有没有办法直接从 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 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(4

未央 2024-09-08 07:00:01

使用 DocProject。它可以创建 HTML 文档以及 CHM。您应该首先安装 Sandcastle

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

鸵鸟症 2024-09-08 07:00:01

VSdocman 可以直接从 Visual Studio 执行此操作。

VSdocman can do it directly from Visual Studio.

超可爱的懒熊 2024-09-08 07:00:01

你可以看看 doxygen

You can have a look at doxygen

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文