2

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

例子:

*沙堡文档类库

Biol..::..f_BiolabTestSayisi Method
Biol Class 另请参阅 发送反馈

Biol hastalarının sayısını veren fonksiyon 命名空间:TR.Biol 程序集:TR(在 TR.dll 中)版本:1.0.0.0 (1.0.0.0)

句法

C# 公共静态数据集 f_BiolTestSayisi()

视觉基础

公共共享函数 f_BiolTestSayisi 作为数据集

视觉 C++

公共:静态数据集^ f_BiolTestSayisi()

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


我可以使用 A Sandcastle Documented Class Library 查看项目中的所有类。我也想看看方法原型和正文。我怎么才能得到它?

提前致谢。

4

2 回答 2

1

您将希望查看使用Sandcastle 组件扩展沙堡构建(这是一篇关于代码项目的非常好的文章,虽然有点旧)。对于已经构建的东西,我建议使用代码块组件,并在您的方法周围放置一个区域。否则你可能需要自己编写一个组件。

请注意,文档不是从实际代码中提取的 - XML 文档注释是由编译器从代码中提取的,然后文档是从该 XML 构建的。这意味着您在构建文档时实际上没有代码(也没有实际的文件/行号)。如果您也管理重载解析,则扩展代码块组件以查找文件/方法名称可能会起作用。

于 2010-10-05T13:32:21.480 回答
0

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

于 2010-10-06T15:42:12.960 回答