Как создать документацию только для HTML из веб-проекта aspdotnet?

Question

Я прокомментировал весь код соответствующими тегами документации ms xml. Как создать документацию только для HTML (или pdf) для всего прокомментированного кода? Я скачал замок из песка, но не могу понять, как перейти к следующему шагу. Спасибо!

Answer 1

Вы можете посмотреть на ndoc http://ndoc.sourceforge.net/

По сути, в свойствах вашего проекта вам нужно включить документацию XML.Поэтому щелкните правой кнопкой мыши свой проект, выберите свойства, перейдите на вкладку «Построение» и установите флажок «XMLDocumentation».

Это создает XML-файл (не HTML).Затем вам нужно преобразовать (или разобрать) файл XML с помощью таблицы стилей XSLT.Вот где приходит nDoc.

Answer 2

Sandcastle (преемник ndoc ) - отличный инструмент для документирования, но по иронии судьбы путь к его простому и эффективному использованию недостаточно документирован.Вам следует использовать Построитель файлов справки Sandcastle (SHFB) или аналогичную платформу, а не пытаться получить прямой доступ к Sandcastle.(Подумайте о солнце: это здорово иметь рядом, но вы не хотите смотреть прямо на него без сильных солнцезащитных очков :-) Тогда возникает вопрос как использовать SHFB ?

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

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

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