生成代码文档到 MS Word 文件

发布于 2024-12-31 22:26:44 字数 1539 浏览 2 评论 0原文

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

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

发布评论

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

评论(4

番薯 2025-01-07 22:26:44

您可以尝试我们的 VSdocman。它可以生成各种格式(包括 RTF)的摘要 XML 注释。

You can try our VSdocman. It can generate various formats, including RTF, of the summary XML comments.

睡美人的小仙女 2025-01-07 22:26:44

代码文档是XML,对吧? 这个人说你可以通过从“打开”对话框中选择“通过转换打开”,在 Word 中打开 XML 文档。显然,这会提示您提供随后用于生成 XSLT 的信息。如果您想保留它,您似乎可以使用它作为您自己的 XSLT 的基础?

这篇关于 Visual Studio 中 XML 注释的详细文章还建议使用 XSLT 来显示网页上的 XML。因此,您也可以将该 XML 导入到您的 Word 文档中

The code documentation is XML, right? This fellow says that you can open an XML document in Word by choosing "open with transform" from the Open dialog box. Apparently that prompts to you provide information that is then used to generate an XSLT. It seems like you could use this as the basis for your own XSLT if you want to persist it?

This detailed article about XML comments in Visual Studio also suggests using XSLT to display the XML on a web page. So, you could just as well import that XML into your Word document

亣腦蒛氧 2025-01-07 22:26:44

SoftArtisan 的 OfficeWriter 可以通过 .NET API 以编程方式创建 .doc 和 .docx 文件。相当拉德,看看吧。

免责声明:我是构建最新版本的工程师之一。

SoftArtisan's OfficeWriter can programmatically create .doc and .docx files via a .NET API. It's pretty rad, check it out.

DISCLAIMER: I'm one of the engineers who built the latest version.

浅黛梨妆こ 2025-01-07 22:26:44

我想将代码文档(C#、.net4)生成为 MS Word 文件(.doc、.docx)。这并不是因为我认为它更好,而是因为与一组 HTML 文档相比,它更容易进行版本控制。

您应该以您认为对软件用户最有帮助的任何格式生成文档。

您的代码可能处于版本控制中。您可以直接从代码生成带有 API 帮助的 XML,并且可以从该 XML 生成帮助文件本身(使用任何工具,以任何格式)。这些输出文件根本不需要进行版本控制。

I would like to generate code documentation (C#, .net4) to MS Word file (.doc, .docx). This is not because I think it is better, but because it is easier to version control when compared to a set of HTML docs.

You should generate the documentation in whatever format you think is most helpful for users of your software.

Your code is presumably in version control. You can generate the XML with the API help directly from the code, and you can generate the help file itself (with whatever tool, in whatever format) from this XML. These output files don't necessarily need to be in version control at all.

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