Генерируйте документацию HTML автоматически во время сборки с Замком из песка

Я рекомендую установить Разработчика Справочного файла Замка из песка от Codeplex.

можно выполнить это из командной строки, например, из события Post-Build. Самая простая командная строка:

<install-path>\SandcastleBuilderConsole.exe ProjectName.shfb

Замок из песка является очень медленным, таким образом, я только выполняю его для Сборок конечных версий. Чтобы сделать это, создайте событие Post-Build с командой что-то как следующее, которое передает имя конфигурации к пакетному файлу:

CALL "$(ProjectDir)PostBuild.cmd" $(ConfigurationName)

Тогда в пакетном файле можно протестировать, если первый аргумент является "Выпуском" и раз так выполняет SandcastleBuilderConsole.exe.

Я должен признать, что нахожу текущую версию Замка из песка небольшим недостатком; для крупных проектов это довольно медленно, и не легко интегрироваться (так как все еще рано).

Для регулярного использования, я на самом деле нахожу легче только указать на отражатель на папку с dll и xml файлами - IIRC, это загрузит xml файл (файлы), поскольку Вы перешли вокруг.

Плюс у меня почти всегда есть отражатель, открытый так или иначе...

[редактирование], проверенное, и да - xml комментирует шоу в панели

Установите их:

NDoc: http://prdownloads.sourceforge.net/ndoc/NDoc-v1.3.1.msi?download

Семинар Справки HTML: http://www.microsoft.com/downloads/details.aspx?FamilyID=00535334-c8a6-452f-9aa0-d597d16580cc&displaylang=en

Тогда использует командную строку NDocConsole.exe для генерации документации или в MSDN или в форме CHM:

@c:\progra~1\NDoc\NDocConsole.exe MyCode.dll,MyCode.xml - Documenter=MSDN-CHM

я сам сделал Внешний Инструмент для этого и дал ему ярлык, но поскольку в предыдущем плакате было сказано, что можно сцепить его до события постсборки, и там Вы идете.

(PS я использовал установку выше в течение нескольких лет теперь и очень доволен им)