Я написал несколько комментариев для своего кода. Теперь, как я могу сгенерировать документацию или что-то подобное с Visual Studio 2010?
Visual Studio 2010: как создать документацию из кодовых комментариев?
Ответ 1
На вкладке свойств сборки включите документацию XML и используйте Sandcastle, чтобы создать файл справки/документации.
Ответ 2
Я описываю инструмент для визуальной студии
VSdocman - комментатор кода Visual Studio и генератор документации
Документируйте свой код .NET на профессиональном уровне.
Создайте полную документацию класса стиля MSDN для ваших проектов на С# и Visual Basic.NET, с настраиваемыми темами, контекстно-зависимой справкой IntelliSense и F1.
Посмотрите, как легко комментирование кода может быть с мощными шаблонами комментариев и сложным редактором комментариев WYSIWYG.
VSdocman - это идеальный инструмент для документирования API для каждого разработчика Visual Studio: создаете ли вы библиотеку классов, компонент, элемент управления, приложение, интеллектуальное устройство или веб-сайт (ASP.NET).
скриншот
Ответ 3
Используя NDoc. NDoc устарел, но есть NDoc3. Другие варианты
Ответ 4
Другой хорошо известной (внешней) системой для создания документации является doxygen
Ответ 5
- С проектом, выбранным в обозревателе решений, в меню "Проект" выберите "Свойства".
- Перейдите на вкладку "Сборка".
- На странице "Создание" выберите файл документации XML. По умолчанию файл создается по указанному пути вывода, например, "Bin\Debug\Projectname.XML".
Ответ 6
Я использовал Sandbule Help File Builder вместе с Sandcastle. Sandcastle Help File Builder - это графический интерфейс для Sandcastle и отнимает всю вашу боль при использовании Sandcastle.