可打印形式的C#类文档

时间:2011-12-08 15:37:51

标签: c# documentation sandcastle

我们使用通常的Sandcastle / XML表示法全面记录了我们的C#源代码。我们使用SHFB将其编译成MSDN样式的文档网站。

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

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



* 1 - 由于我不完全理解的原因。

3 个答案:

答案 0 :(得分:1)

  

有没有一种无痛苦的方法来做到这一点?

不,不要这样做。它对于类级文档没有任何意义 - 没有人会读它。 TAll超链接不起作用,必须更改为页面引用。

  

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

不,不是。它记录了正常的XML文档表示法。沙堡没有发明它。

不,如果你真的必须这样做:

http://www.innovasys.com/products/dx2011/csdocumentation.aspx?cpid=gawdxcs&gclid=COiJq5To8qwCFQGHDgod900o0g

是你可以达到的最佳状态。这是专门的(多目标的东西)。他们还处理需要的额外页面等 - 纯粹的clas引用,没有索引,jsut打印,超链接而不是页面引用基本上是没有任何意义的树破坏。

答案 1 :(得分:0)

Ndoc有一个Latex documentor插件。 NDoc支持Sandcastle支持的所有文档标记,因此应该能够将文档编译为Latex文件。然后可以使用它来创建例如用于打印的Postscript文档。

答案 2 :(得分:0)

直接显然Help and Manual can import Sandcastle projects,然后以各种格式输出它们(包括可打印的格式)。

但是,我自己并没有尝试过。我很想听听任何人的经历。