25 lines
1.7 KiB
Markdown
25 lines
1.7 KiB
Markdown
# Форматирование кода в соответствии с PEP 8 и Google Python Style Guide
|
||
|
||
## Требования к форматированию
|
||
|
||
1. **Добавление Docstring**:
|
||
- Для класса: описание назначения и атрибутов в Google-формате на русском языке
|
||
- Для методов: описание аргументов, возвращаемых значений и возможных исключений
|
||
|
||
2. **Сохранение комментариев**:
|
||
- Разделительные комментарии (например, `#actions:`, `# assertions:`) остаются без изменений
|
||
- Закомментированный код сохраняется в оригинальном виде
|
||
- Технические комментарии в методах не изменяются
|
||
|
||
3. **Перевод комментариев**:
|
||
- Разделительные комментарии переводятся (например, `# Действия:`, `# Проверки:`)
|
||
- Пояснительные комментарии к логике кода переводятся
|
||
- Не переводятся:
|
||
- Технические сообщения в `assert`, `raise` и других системных конструкциях
|
||
- Закомментированный код
|
||
- Сообщения в логах и ошибках
|
||
|
||
4. **Форматирование кода**:
|
||
- Соответствие PEP 8 (отступы, пробелы вокруг операторов)
|
||
- Сохранение исходной структуры кода
|
||
- Без изменений рабочей логики программы |