Вопрос

У меня есть несколько проектов: некоторые используют управляемый код, а некоторые — только неуправляемый.У всех были добавлены комментарии XML, и документация XML генерируется правильно (сгенерированный файл xml и промежуточные файлы xdc).

Наверняка есть что-то, что может взять эти файлы (выходные данные xdcmake) и сгенерировать chm-справку в стиле MSDN!?Насколько я понимаю, и doxygen, и sandcastle игнорируют этот очевидный шаг и заново изобретают колесо для повторного сканирования вашего кода.(есть также тот факт, что Sandcastle, по-видимому, бесполезен для проектов, отличных от .NET).

Попробовав doxygen (ужасный результат, но быстрый) и sandcastle (хороший результат в стиле MSDN, но медленный), оба напрашиваются на что-то гораздо более простое.

Также было бы неплохо, если бы был какой-то связанный редактор, в котором мы также могли бы писать страницы типа «Начало работы» и «Информация», которые также необходимы для любой документации по API.

Кто-нибудь знает какие-либо решения?

Это было полезно?

Решение

Возможно, вы захотите попробовать DoxyКомментарий.Вот описание от Doxygen's Вспомогательные инструменты и сценарии:

Дополнение для Visual Studio 2005 под названием Doxycomment была создана Troels Gram.Он предназначен для того, чтобы помочь вам в вставке контекстных блоков комментариев в исходные файлы C/C ++.Doxycomment также поставляется с шаблоном XSLT, который позволяет генерировать документацию, такую ​​как библиотека MSDN.

Другие советы

Честно говоря, Sandcastle – ваш лучший выбор.Я знаю, что настройка может оказаться непростой задачей, но документация соответствует именно тому стилю, который вам нужен.

Я знаю проект, где люди до сих пор используют NDocConsole

Однако я полагаю, что NDoc — мертвый проект, потому что http://ndoc.sourceforge.net/ обновлений нет с 2005 года

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top