如何向Sandcastle记录的类库中显示方法体

Question

我在Visual Studio 2008中为我的项目制作了类图表，并使用Sandcastle嵌入了这些图表。

示例：

* Sandcastle记录的类库

Biol .. :: .. f_BiolabTestSayisi方法
Biol Class请参见发送反馈

Biolhastalarınınsayısınıverenfonksiyon 命名空间：TR.Biol 汇编：TR（在TR.dll中）版本：1.0.0.0（1.0.0.0）

语法

C＃ public static DataSet f_BiolTestSayisi（）

Visual Basic

公共共享功能f_BiolTestSayisi As DataSet

Visual C ++

公共： static DataSet ^ f_BiolTestSayisi（）

返回值 [缺少“M：TR.Biol.Biol.f_BioTestSayi”的文件] *

---

我可以使用A Sandcastle Documented Class Library查看项目中的所有课程。 我还希望看到方法原型和正文。我怎么能得到它？

提前致谢。

Answer 1

你会想看看使用Sandcastle Components (this is a pretty good article on code project扩展沙堡构建，虽然有点旧。已经建立的东西 我建议使用code block component，并在方法周围放置一个区域。否则你可能需要自己编写一个组件。

请注意，文档不是从实际代码中提取的 - 编译器从代码中提取XML文档注释，然后从该XML构建文档。这意味着在构建文档时（实际的文件/行号也没有）实际上没有代码。如果您也管理重载决策，则扩展代码块组件以查找文件/方法名称。

Answer 2

Sandcastle从已编译的程序集和XML doc文件生成文档。它无权访问原始源代码。如前所述，可能通过使用组件来实现，但您需要修改XML注释。 相反，我们的VSdocman使用不同的方法。它需要XML注释并直接从源代码生成文档。因此它可以轻松地在生成的帮助中包含方法体。如果你不介意商业解决方案，你可以试试。