如何通过反射和XML注释生成适用于MediaWiki的文档

Question

有人能提供一个良好的工作流程，

• 独立于可能需要的各种不同工具的数量
• 以及需要执行多少手动工作，

能够让我将我的项目文档（反思+XML注释）整合到MediaWiki语法中，然后我会将其用于整合到我的开发团队维基上？

- Alexandre Bell

---

有史以来最好的问题之一。 - hoodaticus

Answer 1

这项任务需要一些手动操作，但使用下面列出的资源应该是可行的。

我的第一个想法是通过谷歌搜索来解决问题，我找到了http://www.mediawiki.org/wiki/Alternative_parsers。所有这些解析器似乎都是将数据转换为XML格式，而不是从XML格式转换，而且没有一个是基于.NET的，如果不涉及编码，这可能并不是非常重要。虽然如此，也许有值得关注的东西。

然后我找到了http://www.mediawiki.org/wiki/Manual:Importing_XML_dumps。我想，如果你可以以XML格式导入数据，那么你只需要知道模式，以便以适当的方式重新格式化数据。最好的事情是，这个页面有一个链接http://www.mediawiki.org/wiki/Manual:XML_Import_file_manipulation_in_CSharp，一个使用C#操作Media Wiki XML Import文件的示例。根据这个示例，似乎只需要创建所需的类来从头开始生成所需的xml并转储您的数据即可。这里是官方模式文档的链接：http://www.mediawiki.org/xml/export-0.3.xsd。

根据您是否想编写PHP，还有另一个选项可供选择。您可以编写XMLTransform扩展，如此处所述：http://www.ehartwell.com/TechNotes/MediaWikiXmlExtension.htm。该网站似乎表明，您可以保留原始的XML格式，并编写自定义的XSL样式表以在所需格式中显示内容。

祝你好运！

- Peter

---

非常好，Patricker。这将帮助我入门，我可以从这里开始。谢谢。 - Alexandre Bell

Answer 2

你可以使用沙堡（sandcastle）根据你的源代码创建一个网页 http://documentation.sandcastle.codeplex.com。

你需要在项目设置中启用项目的XML生成功能。 生成的XML可以用于在沙堡中生成一些很酷的文档，例如一个网页。

- Marco

---

这不是我问的，Marco。我非常清楚从我的源代码生成文档的工具。 - Alexandre Bell

Answer 3

我建议使用 doxygen 生成 XML，然后通过 XSLT 或其它工具将所得到的 XML 处理成适合您需要的格式。

如果您已经安装了 graphviz，那么 doxygen 还可以利用它的dot工具来生成各种图表。下面是 doxygen 生成的一个示例（来自 KDE 文档）：http://api.kde.org/playground-api/graphics-apidocs/cirkuit/src/lib/html/inherits.html

以下是另一个相对低调的示例（来自 IBM）：http://www.icu-project.org/apiref/icu4c/classUMemory.html

- Nicholas Carey

---

不知道尼古拉斯，我现在卡在这里了。问题是如何转换成mediawiki格式。 - Alexandre Bell