DocProject vs Sandcastle Файл справки GUI

Question

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

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

Answer 1

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

Answer 2

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

Учебник по Сандкаслу

Конструктор файлов справки Sandcastle (SHFB)
Учебник по SHFB

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

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

Answer 3

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

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

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

Answer 4

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

Конструктор файлов справки Sandcastle надежен и выполняет свою работу.