如何生成.NET程序集的可打印概述?

时间:2011-08-12 16:13:19

标签: .net documentation

我的任务是审查现有的程序集并为它组合一个不错的公共API。这个组件非常大,所以我想概述一下它打印出的内容,以便我可以轻松地浏览它并做笔记。

那里有什么工具可以帮我解决这个问题吗?

我看过NDoc,但这会在很多页面上生成文档。我想要的是一个单独的文件,我可以直接在打印机上打字。

我想我可以将自己的XSLT应用到NDoc创建的XML输出(如果需要),但是在我开始做这项工作之前要确保没有任何工具。

1 个答案:

答案 0 :(得分:2)

您可以使用Framework Design Studio。虽然它的实际目的是设计,检查和区分框架集,但您也可以使用它将程序集的定义导出到文件(RTF,DOC和XML)。我用它和RTF,DOC似乎挂了 - 至少在我的盒子上。结果将是一个文件,其中所有类型(类,接口等)在程序集中都很好地着色。方法主体和其他细节被省略,但我认为你无论如何都不想要它们。

以下示例显示了一个FDS自己的程序集作为Word中的RTF导出:

FDS RTF export in Word

我应该补充一点,FDS并不是机箱中最清晰的工具,但是对于即使是大型装配进行“一次性”输出也应该没问题。