Кому нужен этот промт и как он работает?
Этот промт предназначен для разработчиков и программистов, которые хотят улучшить структуру и качество собственного кода, сделав его более понятным и легким для поддержки. Использование принципов SOLID помогает создавать гибкий, расширяемый и надежный программный код, уменьшая количество ошибок и облегчая тестирование.
Промт автоматически создаёт план действия по переработке неструктурированного кода так, чтобы каждая функция, класс или интерфейс соответствовали пяти основным принципам SOLID. Он также предлагает рекомендации по стандартам именования и тестированию функциональности. Такой подход помогает систематизировать и оптимизировать работу с кодом, экономит время на рефакторинг и улучшает качество программных продуктов.
Готовый к использованию промт
|
1 2 3 4 5 6 7 8 9 10 |
Опишите план по преобразованию неструктурированного кода таким образом, чтобы каждая функция, класс, интерфейс и прочие элементы соответствовали принципам SOLID: - S: Принцип единственной ответственности - функция выполняет только одну задачу. - O: Принцип открытости/закрытости - класс открыт для расширения, но закрыт для модификации. - L: Принцип подстановки Лисков - подклассы могут расширять функциональность суперклассов, но не сокращать её. - I: Принцип сегрегации интерфейсов - классы не должны реализовывать ненужные методы. - D: Принцип инверсии зависимостей - классы зависят от интерфейсов, а не от конкретных классов. Также включите рекомендации по организации читаемости кода: определение стандартов именования функций, переменных и классов, чтобы название отражало их назначение. План должен содержать шаги по выявлению и тестированию всех сценариев выполнения функций. |
Как использовать промт и на что обратить внимание
Перед применением промта подготовьте исходный код, который требует рефакторинга. Чем более полное и точное описание вашего кода вы предоставите, тем более релевантный план преобразования получите.
Обратите внимание на следующие моменты:
- Каждый пункт плана должен быть конкретным и разбит на последовательные шаги для выполнения.
- При описании стандартов именования учитывайте особенности вашей команды или проекта.
- Проверяйте, чтобы все возможные сценарии выполнения функций были описаны и покрыты тестами.
- Промт может не идеально сработать на код со слишком сложной или нестандартной архитектурой, тогда потребуется дополнительная корректировка.
- Результат промта — это план действий, а не готовый код. Реализация остаётся за разработчиком.
Примеры использования
Пример 1. Рефакторинг устаревшего кода большого проекта
Вы работаете с наследием, где функции и классы перемешаны и исполняют множество задач одновременно. Этот промт поможет составить подробный план реструктуризации, упорядочить код по принципам SOLID и улучшить поддержку проекта.
|
1 |
Опишите план по преобразованию устаревшего кода крупного проекта с множеством функций и классов, чтобы каждое звено отвечало принципам SOLID и имело понятные имена. Включите рекомендации по организации тестов, покрывающих все сценарии вызова функций. |
Пример 2. Оптимизация модульного кода для нового приложения
Для нового проекта важно сразу выстроить правильную архитектуру. Используйте промт, чтобы создать шаги создания чистого, расширяемого кода с удобными интерфейсами и четко названными функциями и классами.
|
1 |
Опишите план построения нового модуля приложения согласно принципам SOLID, уделяя внимание именованию функций, классов и переменных, а также разработке тестов для каждого функционала. |
Пример вывода нейросети по этому промту
✅ Пример: План включает следующие шаги: 1) Анализ существующего кода с выявлением функций, выполняющих несколько задач (S). 2) Разбиение таких функций на более мелкие по задаче. 3) Определение точек расширения классов без изменения исходного кода (O). 4) Проверка наследуемых классов на совместимость с базовыми (L). 5) Разделение интерфейсов на минимальные наборы методов, необходимых классам (I). 6) Рефакторинг зависимостей с использованием абстракций и интерфейсов (D). 7) Внедрение стандартов именования по шаблонам: функции с глаголом в названии, классы — существительным в единственном числе. 8) Создание тестов для каждой функции с учетом всех вариантов выполнения. Такой подход повысит читаемость и расширяемость кода.
Примечание: результат примерный и может варьироваться.
Итог: зачем использовать этот промт?
Этот промт значительно облегчает процесс рефакторинга и повышения качества кода. Он помогает системно подойти к структуре программного обеспечения, сделать код более поддерживаемым, понятным и гибким к изменениям. Использование плана, разработанного по принципам SOLID, сокращает время на доработки и улучшает стабильность проекта.
Основное преимущество: быстрый и понятный план по улучшению кода согласно SOLID, с рекомендациями по именованию и тестированию.
