有人可以建议一个好的工作流程,
- 独立于可能需要的不同工具的数量
- 以及必须执行多少人工工作,
可以让我将我的项目文档(反射 + xml 注释)合并到 mediawiki 语法中,然后我将使用它来合并到我的开发团队 wikia 中吗?
有人可以建议一个好的工作流程,
可以让我将我的项目文档(反射 + xml 注释)合并到 mediawiki 语法中,然后我将使用它来合并到我的开发团队 wikia 中吗?
将涉及一些体力劳动,但使用下面概述的资源应该是可行的。
我的第一个想法就是做一些谷歌搜索,通过它我遇到了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的链接,这是一个关于如何使用 Media Wiki XML 导入文件的 C# 示例。鉴于这个例子,创建从头开始生成所需的 xml 并将数据转储到所需的类似乎只是一小步。这是官方模式文档的链接:http ://www.mediawiki.org/xml/出口-0.3.xsd。
取决于您是否要编写 PHP 或是否出现另一个选项。您可以编写一个 XMLTransform 扩展,如下所述:http: //www.ehartwell.com/TechNotes/MediaWikiXmlExtension.htm。该站点似乎说您可以将 XML 保持在其本机格式并编写自定义 XSL 表以所需格式显示内容。
祝你好运!
您可以使用 sandcastle 从您的源代码http://documentation.sandcastle.codeplex.com创建一个网页
您必须在项目设置中启用项目的 XML 生成。生成的 XML 可以在沙堡中用于生成一些很酷的文档,例如作为网页。
我会考虑使用doxygen来生成 XML,然后将生成的 XML(XSLT 或您选择的工具)处理成适合您需要的东西。
如果你已经安装了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