#build-process #build-automation #documentation
Вопрос:
Существует ли какой-либо способ создания документов проекта во время автоматической сборки?
Я хотел бы иметь один набор исходных файлов (HTML?) с руководством пользователя и на их основе генерировать:
- PDF-документ
- Помощь CHM
- HTML — версия справки
Содержание будет в основном одинаковым во всех трех форматах.
В настоящее время я использую msbuild и CCNET, но при необходимости я мог бы изменить это.
Ответ №1:
Да!
- Используйте SandCastle для создания документации CHM/HTM по API.
- Используйте DocBook FOP и другие инструменты для создания других видов документации в формате PDF, RTF, HTML и т.д…
Они могут быть легко интегрированы с CruiseControl.СЕТЬ через Нанта.
Ответ №2:
Вы пробовали доксиген? Он также доступен для Windows, и его должно быть легко интегрировать в любой сценарий/процесс сборки.
Ответ №3:
Проект Apache Forrest может каким-то образом дать вам то, что вы хотите.
Как правило, вам будет лучше писать свою документацию в формате XML. Исходя из этого, вы должны быть в состоянии генерировать практически все, что вам нужно.
Ответ №4:
Справка и руководство могут генерировать PDF, HTML и CHM хорошего качества (и другие форматы) из одного источника. Он также имеет интерфейс командной строки. У меня есть версия 4, и она мне очень нравится. Я использую условные обозначения (например, #ifdefs) для создания версий моей документации для Windows и Mac в различных форматах как части файла build .bat/.csh. Теперь доступна версия 5.
Ответ №5:
Если вы также хотите, чтобы ваш api был задокументирован, и вы используете msbuild, рассмотрите возможность использования DocProject для управления сборкой SandCastle. (Эти инструменты не предназначены для документации конечного пользователя…)
Ответ №6:
У меня был опыт работы с Доксигеном. Это приятно и просто, но это заставляет вас хотеть переопределить код, чтобы облегчить последующую работу по документированию.