Проведите комплексную ревизию и документирование указанного модуля или пространства имён. Выполните следующие задачи:
Напишите полный README.md файл, включающий:
- Основные возможности - список ключевых функций модуля
- Архитектура - описание всех основных компонентов с диаграммами/схемами
- Основной цикл обработки - блок-схема или текстовое описание потока данных
- Примеры использования - базовые и продвинутые примеры с кодом
- Поддерживаемая функциональность - список команд, методов, свойств
- Конфигурация - описание файлов и параметров конфигурации
- Точки расширения - как добавлять новые функции
- Производительность - рекомендации по оптимизации
- Обработка ошибок - описание исключений и их причин
Для всех публичных типов и методов добавьте:
<summary>- краткое описание (одна строка)<remarks>- подробное объяснение (многострочное)<param>- описание параметров с типами<returns>- описание возвращаемого значения<exception>- выбрасываемые исключения<example>- практические примеры использования в блоке<![CDATA[]]>
Переведите все комментарии в коде на целевой язык (указать в инструкции):
- Встроенные однострочные комментарии
- Многострочные блочные комментарии
- Сохраняйте техническую терминологию в том же языке (CamelCase имена, аббревиатуры)
Проанализируйте код на:
- Ошибки компиляции и синтаксические проблемы
- Потенциальные ошибки в реализации
- Нарушения принципов SOLID
- Проблемы с обработкой исключений
- Неиспользуемый код
- Архитектурные проблемы
Выполните следующий рабочий процесс:
- Создайте feature-ветку (например,
feature/module-review-and-docs) - Добавьте и закоммитьте все изменения с описательными сообщениями
- Переключитесь на целевую ветку (обычно
dev) - Выполните merge feature-ветки в целевую ветку
- Удалите временную feature-ветку
- Проверьте успешную интеграцию
Создайте отчёт, включающий:
- Список всех модифицированных файлов
- Количество добавленных и удаленных строк
- Краткое описание каждого изменения
- Выявленные проблемы (если есть)
- Рекомендации по дальнейшему улучшению
- Git информацию (ветка, commit ID, статистика merge)
- Проект успешно компилируется
- README.md создан и содержит полную документацию
- XML-комментарии добавлены ко всем публичным членам
- Все комментарии переведены на целевой язык
- Примеры кода заключены в блоки CDATA
- Проведена ревизия качества кода
- Git операции выполнены успешно
- Итоговый отчёт составлен