Есть ли хорошее краткое руководство по созданию документации API с помощью Sandcastle?

Question

Я собираюсь создавать документы API с использованием Sandcastle - я не смог найти никаких руководств по тому, как это сделать, на своем веб-сайте. У кого-нибудь есть какие-нибудь быстрые руководства, которые они бы порекомендовали?

Answer 1

Я бы посоветовал использовать SHFB (если вы можете), поскольку это действительно упрощает процесс. SHFB поставляется с документацией, но вы сможете использовать его общие функции без каких-либо руководств.

Answer 2

Я также решительно поддерживаю SHFB , настолько, что в сентябре 2010 года я написал значительную статью о Sandcastle и SHFB под названием Taming Sandcastle: Руководство программиста .NET по документированию вашего кода где я описываю советы по использованию и много потенциальных ловушек, с которыми можно столкнуться. В октябре 2010 года я последовал за этим одностраничной настенной диаграммой , в которой обобщен лексикон комментариев XML-документации для SHFB.

Из моего исследования для статьи, вот полный список других полезных ресурсов:

• Документация построителя файлов справки Sandcastle Эрика Вудраффа (создатель SHFB)
• Руководство по программированию в C #: Рекомендуемые теги для комментариев к документации (MSDN)
• Wm. Справочник Эрика Брансена по комментариям к документации XML (Dynicity)
• Документация Энсона Хортона XML на C # (менеджер программ компилятора Microsoft C #)

Answer 3

Может быть, вы можете проверить (codeplex) сайт SandCastle . Но мой опыт показывает, что лучше всего поиграть с этим. Первое, что вам нужно сделать, это настроить приложение для генерации ваших комментариев в XML-файл (и с использованием XML-комментариев в вашем коде). Это настройка в вашем проекте.

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

Удачи, играя с ним!