DocProject vs Sandcastle Help File Builder GUI

У меня есть несколько проектов С# наряду с некоторыми внутренними библиотечными компонентами, которые я пытаюсь документировать вместе. Кажется, что Sandcastle подходит для создания документации с С#. Я хотел бы знать, какой из двух, DocProject или Sandcastle Help File Builder GUI лучше и поддерживает функции, которые мне нужны.

Я хотел бы скомпилировать только каждый проект собственной части документа, а затем объединить его в конце. (т.е. компоненты библиотеки в одном проекте документации и каждый проект в нем собственного проекта документации, а затем все вышеперечисленное в одном корневом режиме с помощью средства просмотра справки 2)

Ответ 1

Я могу поручиться за Sandcastle Help File Builder. Он работает очень хорошо, и вы можете документировать любое количество сборок в проекте Sandbule Help File Builder. Теоретически, вы могли бы иметь проект Builder и генерировать документ для каждого проекта С#, а затем иметь проект мастера Builder, который документирует все.

Ответ 2

Вот несколько полезных ссылок для документации .NET на базе Sandcastle:

Учебник по Sandcastle

Builder Builder (SHFB)

Учебник по SHFB

Документация по веб-проектам
Учебное пособие по документированию веб-проектов (Более ручное и, я считаю, устаревшим, учитывая предыдущую ссылку)

Ссылка MSDN для документации XML

Ответ 3

Я не использовал DocProject, но это похоже на продукт с возможностями, сопоставимыми с Sandcastle.

Я использовал Sandcastle, и я считаю его эффективным инструментом. Вам также понадобится Sandbule Help File Builder (SHFB), чтобы дать вам хороший интерфейс, как это упоминали другие. Кроме того, вам нужно Sandcastle Styles для патчей уровня представления для движка Sandcastle. В то время как все три из этих компонентов имели новый выпуск в середине 2010 года, я откладываю обновление с выпуска 2008 года из-за дефекта рендеринга в Firefox 3.6 (задокументированный в записи этого отчет о дефектах).

Я полностью задокументировал свой опыт работы с платформой, описывающей эту проблему, и ряд других, которые вам могут понадобиться или которые вы хотите рассмотреть, чтобы создать удобный набор профессиональных документов. Моя статья " Taming Sandcastle: Руководство программиста .NET для документирования вашего кода" было опубликовано только на Simple-Talk.com в сентябре 2010 года; он может сохранить вас некоторое время, усилие и агонию: -).

Ответ 4

Doc Project производит больше полированных документов - когда он работает - это не всегда. Это гораздо более плотный продукт.

Sandcastle Help File Builder прост и выполняет задание.