Sandcastle是否支持代码合同?

我的图书馆使用代码合同。

有没有办法将这些合同纳入sandcastle生成的文档中?


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

Sandcastle本身不支持它,但Code Contracts附带所需的文件。

首先确保您为您的程序集生成文档,然后在项目的代码合同设置中,将合同参考大会设置为“生成”,并选中“将合同放入XML文档文件”复选框。

接下来,打开C:Program Files (x86)MicrosoftContractsSandcastleSandcastle.zip (或者在32位安装中只是C:Program Files... - 以下说明也是如此)。

你需要提取什么取决于你是安装Sandcastle的MSI还是源码(它们实际上是不同的版本):

  • 如果来自MSI,请将msivs2005下的所有内容解压缩到C:Program Files (x86)SandcastlePresentationvs2005 ,并覆盖所有冲突。
  • 如果从源代码提取sourcevs2005所有内容到C:Program Files (x86)SandcastlePresentationvs2005 ,并覆盖所有冲突。
  • 最后,您需要创建一个新的Sandcastle项目。 您可以从向导中导入旧主题和设置。

    然后,您应该可以运行Sandcastle并在文档中拥有合同。


    它与Sandcastle一起工作,虽然有一些必要的调整来完全整合它们。 请参阅http://desearch.microsoft.com/en-us/projects/contracts/userdoc.pdf上的“代码合同用户手册”日期为2011年2月4日(或稍后)的第8.3节


    答案现在已过时。

    Sandcastlestyles现在似乎已被弃用,如果您尝试将最新的Code Contracts分发版(截至2013年9月13日)提供的补丁应用到最新的Sandcastle发行版,那么它将打破Sandcastle,大概是因为该补丁不再与Sandcastle版本。

    链接地址: http://www.djcxy.com/p/59595.html

    上一篇: Does Sandcastle support code contracts?

    下一篇: put example code in documentation by using sandcastle