可打印形式的 C# 类文档

标签 c# documentation sandcastle

<分区>

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

我们现在需要*1 将文档编译成可打印的形式。理想情况下,我们想要一个 PDF 文档,但具体格式不如其可打印性重要。重要但不重要的是,文档看起来比较专业,可以打上企业logo等。

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



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

最佳答案

Is there a mostly pain-free way to do this?

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

Our C# source code is comprehensively documented using the usual Sandcastle/XML notation.

不,不是。它记录了正常的 XML 文档符号。它不是 SandcaSTLe 发明的。

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

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

几乎是您所能达到的最好的。他们专门从事于此(多目标的东西)。他们还处理所需的其他页面等 - 纯类引用,没有索引,只是打印,带有超链接而不是页面引用,基本上是没有任何意义的树破坏。

关于可打印形式的 C# 类文档,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8433498/

相关文章:

c# - 使用/p :PublishSingleFile=true Flag 发布时出错

c# - 也许monad只是为了什么?

c#-2.0 - sandcaSTLe 生成的 .chm 帮助文件有问题吗?

c# - 在 SQL SERVER Reporting Services (SSRS) 中显示 rtf 数据

c# - Unity如何使GameObject实例在被引用时被销毁?

ruby-on-rails - 为什么 yard 不在 Rails 项目中显示私有(private)方法?

python - 在 python 中检索对象的 'help' 文档字符串

documentation - 公司坚持对我们所有的文档使用二进制格式

xml - 无论如何,我可以使用 SandcaSTLe 从安装了 Microsoft Visual Web Developer 2010 Express 的 .xml 文件创建 .chm 文件吗?

c# - 从另一个索引器继承文档的语法是什么?