У меня есть решение vs2012, в котором есть несколько проектов С#. Я хотел бы создать некоторую документацию, используя Sandcastle для всей библиотеки.
Я просматривал документацию Sandcastle и не понимаю, как я могу создать документацию для всего проекта.
Как я могу добиться этого для всего решения?
Как указал ChrisW, вы должны использовать Sandcastle Help File Builder (SHFB). Тем не менее, даже с чистым и простым графическим интерфейсом, предоставляемым SHFB, существует довольно много вопросов, которые вам могут понадобиться или которые вы хотите рассмотреть, чтобы создать аккуратный, профессиональный набор документации. Моя статья ("Укрощение замка из песка: руководство для программиста .NET по документированию кода"), документирующий мой опыт работы с различными подводными камнями, опубликованный на Simple-Talk.com, может сэкономить вам время и усилия. , и агония :-).
После того, как вы ознакомились со статьей и, возможно, представляете больший интерес, я помещаю полное руководство по синтаксису и использованию SHFB и Sandcastle на этот одностраничная настенная диаграмма, доступная на Simple- Talk.com. Вот краткий обзор:
Я использовал построитель файлов справки Sandcastle (вместо непосредственного использования Sandcastle).
В проекте SHFB вы можете указать несколько DLL + XML в разделе <DocumentationSources>.
