.net - SandcaSTLe 是否支持代码契约？

Question

我的图书馆使用代码契约。

有没有办法将这些契约(Contract)合并到由 SandcaSTLe 生成的文档中？

Answer 1

编辑:原来这个方法已经过时了；只需安装 Sandcastle Styles .

SandcaSTLe 本身不支持它，但 Code Contracts 附带了所需的文件。

首先确保您正在为您的程序集生成文档，然后在您的项目的代码契约(Contract)设置中，将契约(Contract)引用程序集设置为“构建”，并选中“将契约(Contract)发送到 XML 文档文件”框。

接下来打开C:\Program Files (x86)\Microsoft\Contracts\Sandcastle\Sandcastle.zip (或者只是 C:\Program Files\... 在 32 位安装上 - 和下面的说明相同)。

您必须提取的内容取决于您是使用 MSI 还是从源代码安装 SandcaSTLe(它们实际上是不同的版本):

如果从 MSI 中提取 msi\vs2005\ 下的所有内容至 C:\Program Files (x86)\Sandcastle\Presentation\vs2005\ ，并覆盖所有冲突。

如果来自源代码，则提取 source\vs2005\ 下的所有内容至 C:\Program Files (x86)\Sandcastle\Presentation\vs2005\ ，并覆盖所有冲突。

最后，您需要创建一个新的 SandcaSTLe 项目。您可以从向导中的旧主题和设置导入您的主题和设置。

然后你应该能够运行 SandcaSTLe 并在文档中有契约(Contract)。