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

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

Источник

2 ответа

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

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

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

Источник

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

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

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

Источник
Другие вопросы по тегам