可打印形式的C#类文档

Question

我们的C#源代码使用通常的Sandcastle/XML表示法进行全面记录.我们使用SHFB将其编译成MSDN风格的文档网站.

我们现在需要^*1 将文档编译成可打印的形式.理想情况下,我们想要PDF文档,但具体格式不如其可印刷性重要.重要但非关键的是,文档看起来相对专业,可以使用公司徽标等标记.

有没有一种无痛苦的方法来做到这一点？ 我不认为单独打印文档网站的每一页都是一个实用的选择.原则上,中间XML文档文件可以转换为可用的格式,但是对于这项任务,可能已经有了可行且可维护的解决方案吗？

^{*1 - 由于我不完全理解的原因.}

Answer 1

有没有一种几乎无痛的方法来做到这一点？

不，不要这样做。对于类级别的文档来说，它毫无意义——没有人会读它。所有超链接都不起作用，必须更改为页面引用。

我们的 C# 源代码使用常用的 Sandcastle/XML 表示法进行了全面记录。

不它不是。它记录了正常的 XML 文档符号。Sandcastle 没有发明它。

现在，如果你真的必须这样做：

几乎是你能达到的最好的。他们专门从事这一领域（多目标的事情）。它们还处理所需的附加页面等 - 纯类引用，没有索引，只是打印，用超链接而不是页面引用基本上是没有任何意义的树破坏。