Описание задачи

Имеется обширная кодовая база на C#, включающая в себя библиотеки большого фреймворка для Windows и код клиентского приложения. На начальном этапе разработки документация не велась, что существенно затрудняет сопровождение продукта, онбординг новых разработчиков и аудит кода.

Цель

Провести автоматическое или полуавтоматическое ретроспективное документирование исходного кода при помощи инструментов на базе искусственного интеллекта.

Требования к работе

• Анализ кода: Исполнитель должен проанализировать структуру и объемы кода (представлено неупомянутое легаси).
• Выбор ИИ-инструмента: Предложить или использовать консольный/плагинный ИИ-решение для генерации XML-документации (summary, param, returns).
• Форматирование: Итоговая документация должна строго следовать стандартам C# XML-комментариев.
• Качество: Комментарии должны быть осмысленными, объяснять логику для разработчиков (на русском или английском по согласованию).
• Интеграция: Документация должна быть внедрена прямо в код (в файлы .cs), не нарушая работоспособность сборки проекта.

Результат

Покрытие существующих публичных и внутренних (internal/protected) методов, классов, свойств XML-комментариями, пригодными для генерации документации в Sandcastle, Doxygen а так же напрямую всплывающими в IntelliSense внутри Visual Studio.Результат сообщества в системе контроля.