在Sandcastle之前处理XML文档文件

时间:2014-05-06 09:51:21

标签: c# build-process sandcastle xml-documentation

我的C#代码包含XML注释。在编译期间,Visual Studio会创建XML文档文件,然后由Sandcastle使用它们来创建CHM文件。

现在,懒惰,我想避免编写XML注释,如果它们包含的信息已存在于其他地方。我的一些课程以自定义属性的形式提供有关其成员的其他信息。因此,我正在寻找一种在Sandcastle处理之前自动将此信息添加到XML文档文件的简单方法。

我的想法是在程序集中添加一个构建后的步骤,或者为Sandcastle项目添加一个预构建步骤。无论哪种方式,此构建步骤都会将生成的XML文档文件读入DOM,对已编译的程序集进行一些反射,将此信息添加到XML DOM,并覆盖原始XML文件。

现在我想知道:

  • 我在这里重新发明轮子吗?是否有一些现有的机制可以向文档添加信息?
  • 如果我的方法确实是最简单的解决方案:是否有一些现有的库包装XML文档文件并允许轻松修改,或者XDocument是我最好的选择? 注意:我确实找到了NuDoc,但似乎只是为了阅读。我还发现了MSDN artible Processing the XML File,因此至少记录了XML文件格式。

0 个答案:

没有答案