2012-01-31 63 views
3

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

我正在研究这种可能性和实用性,并权衡选项。

我看到doxygen可以生成RTF文件。 doxygen没有问题,我只想知道是否有其他东西(付费或不是),以确保我已经权衡了几种不同的选择。

编辑:为防万一还不清楚,我想在C#代码中创建夏季评论的文档。 Visual Studio已经将它导出到XML。像doxygen这样的工具会检查代码将它们自行存档。我想将这些评论转换为Word文档。

回答

4

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

+0

你知道我看了几次VSdocman,很遗憾地说我错过了它输出RTF文件......谢谢。 – Tony 2012-01-31 21:03:18

+0

仅供参考,截至版本6.2 VSdocman可以直接生成DOCX格式(我是其开发人员之一)。 – 2013-03-21 13:35:06

0

代码文档是XML,对吧? This fellow表示您可以通过在“打开”对话框中选择“使用变换打开”来打开Word中的XML文档。显然,提示您提供的信息随后用于生成XSLT。如果你想坚持它,似乎你可以用它作为你自己的XSLT的基础?

关于Visual Studio中的XML注释的detailed article也建议使用XSLT在网页上显示XML。因此,您可以将XML导入到您的Word文档中

0

SoftArtisan的OfficeWriter可以通过.NET API以编程方式创建.doc和.docx文件。这很不错,检查出来。

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

0

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

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

你的代码大概是在版本控制。您可以直接从代码生成带有API帮助的XML,并且可以使用此XML自身生成帮助文件(无论采用何种格式)。这些输出文件不一定需要进行版本控制。

+0

对此的推理很尴尬。简短的版本是我知道HTML文档使用起来更好。但是,导出不适用于最终用户。版本控制是客户设定的过程的一部分... – Tony 2012-01-31 21:00:40

+0

好的,谢谢澄清。不要忘记,如果您只需要为每个版本添加一次文档到版本控制,就可以手动将HTML导入Word。 – 2012-02-01 00:08:15