Поддерживает ли код поддержки Sandcastle?

В моей библиотеке используются кодовые контракты.Поддерживает ли код поддержки Sandcastle?

Есть ли способ включить эти контракты в документацию, создаваемую sandcastle?

2010-08-26 user380719

Редактировать: Оказалось, что этот метод устарел; просто установите Sandcastle Styles.

Sandcastle не поддерживает его, но Code Contracts поставляется с необходимыми файлами.

Прежде всего убедитесь, что вы создаете документацию для своей сборки, а затем в настройках кода контракта для своего проекта, установите ссылку на контрактную сборку на «Построить» и установите флажок «Испускать контракты в файл XML doc».

Далее, откройте C:\Program Files (x86)\Microsoft\Contracts\Sandcastle\Sandcastle.zip (или просто C:\Program Files\... на 32-разрядной установке - и то же самое для инструкций ниже).

То, что вы должны экстракт зависит от того, установлены ли вы Sandcastle с MSI или от источника (они на самом деле разные версии):

если от MSI, извлечь все под msi\vs2005\ к C:\Program Files (x86)\Sandcastle\Presentation\vs2005\, и перезаписать любые конфликты.
если из источника, извлеките все под source\vs2005\ до C:\Program Files (x86)\Sandcastle\Presentation\vs2005\ и перезапишите любые конфликты.

И, наконец, вам необходимо создать новый проект Sandcastle. Вы можете импортировать свои темы & настроек из старого в мастере.

Тогда вы должны иметь возможность запускать Sandcastle и иметь контракты в документации.

источник

2010-08-26 23:37:08 porges

На самом деле все, что вам нужно сделать, это установить http://sandcastlestyles.codeplex.com/ (см. Http://social.msdn.microsoft.com/Forums/en-US/codecontracts/thread/49f64a19- fd3b-45a9-8d4e-d59eacf0f0d5) Спасибо, что указал мне в правильном направлении. – user380719

Ну, это проще :) Я шел по документации, которая поставляется с Code Contracts. – porges

Одна вещь, о которой следует помнить, заключается в том, что ** Код документа XML Code не генерируется по умолчанию **. Вам нужно войти в «Свойства проекта» на вкладку «Контракты кода», установить раскрывающийся список «Сводка по контракту», чтобы создать и проверить контракты «Эмитировать» в файл документа XML. См. Здесь для получения дополнительной информации: (http://dotnet.dzone.com/articles/code-contracts-%E2%80%93-generating). – SteveWilkinson

Он работает с Sandcastle, хотя есть некоторые настройки, необходимые для их полной интеграции. См. Раздел 8.3 в Руководстве по кодовым контрактам от 02.04.2011 (или более поздней), доступный по адресу http://research.microsoft.com/en-us/projects/contracts/userdoc.pdf

источник

2011-10-13 17:36:43

Ответы теперь устарели.

Sandcastlestyles теперь кажется устаревшим, и если вы попытаетесь применить патч, поставляемый с последним дистрибутивом Code Contracts (начиная с 13 сентября 2013 года), до последнего дистрибутива Sandcastle, то он сломает Sandcastle, предположительно, потому что патч не является более продолжительный синхронный с выпуском Sandcastle.

источник

2013-09-13 08:53:25

Поддерживает ли код поддержки Sandcastle?

ответ

Смежные вопросы