Главная / Программирование и IT / Проверка инициалов кода

Проверка инициалов кода

Описание промпта

Эксперт по читаемости кода анализирует имена переменных, функций и классов. Выявляет неясные, вводящие в заблуждение или несогласованные инициалы. Предлагает улучшения, соответствующие языковым конвенциям и контексту проекта.

Что делает этот промпт

Автоматизированный ревьюер имен кода. Анализирует переменные, функции и классы на ясность, согласованность и соответствие стандартам. Выдает оценку и конкретные предложения по рефакторингу.

Преимущества

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

Для кого подходит

Разработчики, тимлиды и code reviewers, стремящиеся улучшить качество кодовой базы и внедрить строгие стандарты именования.

Инструкция по использованию промпта

Вставь код в {{CODE}}, укажи язык в {{LANGUAGE}} и стиль в {{STYLE_GUIDE}}. Если стиль отсутствует, оставь поле пустым или напиши 'none'. Контекст {{CONTEXT}} опиши кратко (например, 'веб-приложение для электронной коммерции').

Что нужно предоставить

Необходимо предоставить исходный код, язык программирования и, при наличии, гайдлайн стиля проекта. Контекст помогает точнее подобрать синонимы.

Что ожидать в результате

Структурированный отчет с оценками по 4 критериям, списком критических проблем с предложениями по исправлению, списком улучшений и примером рефакторинга.

Рекомендации

Prompt оптимизирован для языков с сильной типизацией и общепринятыми конвенциями (JS, Python, Java, C#). Для динамических языков с гибким стилем акцент смещается на ясность намерения.

Ограничения

Не заменяет глубокий архитектурный анализ. Может предлагать избыточные имена в узких областях видимости, если контекст не задан. Не проверяет логику, только именование.

Переменные

CODE

Обязательная

Исходный код для анализа

LANGUAGE

Обязательная

Язык программирования

STYLE_GUIDE

Необязательная

Гайдлайн стиля проекта

CONTEXT

Необязательная

Контекст использования кода

Промпт открыт для всех. Зарегистрируйтесь, чтобы копировать одним кликом, сохранять промпты, оценивать их и подписываться на авторов.

Текст промпта

ChatGPT / Claude / Llama Войти для копирования

Выступи в роли эксперта по читаемости кода с 15-летним опытом. Твоя задача — проанализировать предоставленный код на качество именования. Имена должны снижать когнитивную нагрузку, предотвращать ошибки и служить документацией.

## Входные данные
Код:
{{CODE}}

Язык: {{LANGUAGE}}
Стиль проекта: {{STYLE_GUIDE}} (если есть)
Контекст: {{CONTEXT}}

## Инструкция
Проанализируй код и выдай отчет в следующем формате:

### Оценка качества именования
- **Общая оценка**: [1-10]
- **Ясность**: [1-10]
- **Согласованность**: [1-10]
- **Соблюдение конвенций**: [1-10]

### Проблемы с именами

#### Критические (Вводящие в заблуждение)
Имена, которые могут вызвать баги или путаницу.

##### Проблема 1: [Текущее имя]
- **Место**: Строка [N]
- **Проблема**: [почему это плохо]
- **Предлагаемое имя**: `[лучшее_имя]`
- **Обоснование**: [почему это лучше]

#### Возможности для улучшения
Имена, которые работают, но могли бы быть понятнее.

#### Несогласованность стиля
Имена, не соответствующие конвенциям языка или проекта.

### Обнаруженные паттерны именования
Краткое описание использованных паттернов (хороших и плохих).

## Ограничения
### ДЕЛАЙ
- Проверяй: однобуквенные переменные (кроме счетчиков циклов), сокращения, неясные имена, общие имена (data, info, temp, result), отрицательные булевы значения, несогласованное множественное число.
- Проверяй конвенции языка: camelCase, snake_case, PascalCase, SCREAMING_SNAKE_CASE.
- Убеждайся, что имена раскрывают намерение, а не реализацию.
- Проверяй, что булевы имена читаются естественно (is_active, has_permission).
- Проверяй, что имена функций — глаголы, а классов — существительные.
- Ищи венгерскую нотацию или префиксы типов (обычно устарело).
- Учитывай терминологию домена.

### НЕ ДЕЛАЙ
- Не навязывай личные предпочтения без обоснования.
- Не предлагай слишком длинные имена, ухудшающие читаемость.
- Не игнорируй установленные конвенции проекта.
- Не упускай контекст (короткие имена допустимы в малых областях видимости).
- Не будь педантом по мелочам.

Проверка инициалов кода

Поделитесь в социальных сетях

Комментарии