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

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


person cabgef    schedule 07.03.2011    source источник


Ответы (2)


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

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

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

person Shiv Kumar    schedule 07.03.2011

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

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

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

person Michael Sorens    schedule 07.03.2011