Как экспортировать документацию по коду в C#/VisualStudio 2008?

Question

Я всегда старался писать хорошие комментарии к коду для классов и методов с использованием синтаксиса C# xml.Я всегда ожидал, что позже смогу легко экспортировать их.

Сегодня мне действительно нужно это сделать, но я не могу понять, как это сделать.Есть ли что-то, что мне не хватает?Я хочу пойти Меню->Сборка->Документация по коду сборки, но там нет такой возможности.

Answer 1

На самом деле это в свойствах проекта.Вкладка «Сборка», раздел «Вывод», файл документации XML и введите имя файла.Он будет построен на каждой сборке проекта.

После этого вы можете создать реальную помощь с помощью замок из песка.

Answer 2

Вы могли бы попробовать НДОК или Замок из песка если вы не против использовать сторонние инструменты.

Answer 3

замок из песка очень хорошо работает для создания документации и поддерживает несколько различных форматов для создания.Насколько я знаю, для него нет интеграции с Visual Studio, но есть Песчаный замокGUI для этого то, что имеется.

Answer 4

Будьте осторожны, если вы используете LINQ to SQL, поскольку вы не сможете легко добавлять устойчивые комментарии к автоматически созданным объектам.

Answer 5

Комментарий поздний, но стоит добавить, что хотя Песчаный замок и законсервирован, Конструктор файлов справки Sandcastle находится в активной разработке, и я нашел его очень мощным и простым в использовании именно в этой ситуации - установка на расширенный вывод .chm и .html/.asp за пару часов.

Answer 6

Исходный проект NDoc (упомянутый другими) мертв, но есть новый проект под названием NDoc3.

NDoc3 поддерживает .NET 2.0–3.5.В настоящее время он доступен в виде бета-версии и отлично работает для меня.Я не уверен, что проект все еще активен — последняя бета-версия вышла в апреле 2009 года.