Создание документации Sandcastle при создании проекта Visual Studio - PullRequest
8 голосов
/ 25 октября 2011

Я использую конструктор файлов справки Sandcastle для вывода моего файла C # XML-DOC в формат веб-сайта. Как я могу сделать то же самое из командной строки, чтобы я мог добавить это как событие сборки в Visual Studio при сборке реального проекта?

Конечной целью является создание содержимого файла справки на веб-сайте при создании проекта Visual Studio.

Ответы [ 4 ]

9 голосов
/ 25 октября 2011

Как указал Скотт Уайли, вам нужно указать это в командной строке события после сборки в свойствах проекта Visual Studio. Однако я бы предложил использовать Filecast Help Builder (SHFB), а не Sandcastle напрямую. Это делает вызов командной строки коротким и простым, как показано ниже, но обратите внимание, что сначала вы должны сконфигурировать проект SHFB с графическим интерфейсом SHFB, который создает совместимый с msbuild файл сборки с суффиксом ".shfbproj":

    C:\Windows\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe
        /p:Configuration=Release myProject.shfbproj

Однако обратите внимание, что я использую противоположный подход к тому, что вы делаете: вместо использования Visual Studio для интерактивного запуска сборки и вспомогательных действий я использую ant (nant) для запуска сборки всего, включая мою Visual Studio решения и последующее действие ШФБ. Так что это действительно вызов командной строки, который я делаю для создания документации с помощью Sandcastle:

<exec executable="${msbuild}" dir="${csharpdoc}" output="${csharpdoc.log}">
    <arg value="/p:Configuration=Release"/>
    <arg value="myProject.shfbproj"/>
</exec>

Я предпочитаю, чтобы вся сборка запускалась из командной строки, поэтому никаких взаимодействий не требуется (например, запуск Visual Studio и т. Д.). Это обеспечивает гибкость запуска как запланированной повторяющейся задачи или по требованию из оболочки.

1 голос
/ 25 октября 2011

Вы можете вызвать SandCastle из командной строки события после сборки, в разделе «События сборки» в свойствах вашего проекта. Это должно хорошо работать, если вы не используете какой-либо инструмент для автоматической сборки.

0 голосов
/ 18 апреля 2013

Мне было проще всего добавить в решение проект * .shfbproj. Он хорошо работает (хотя и немного медленно) внутри VS 2010.

0 голосов
/ 25 октября 2011

Если вы используете MSBuild для своего инструмента сборки, это учебник , который я использовал некоторое время назад.

Существует также сценарий на codeplex , который вы можете использовать, чтобы помочь вам.

Надеюсь, это поможет!

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...