Кодинг и стиль

Python

• PEP8 + типизация (typing)
• Докстринги Google / NumPy style
• 4 пробела для отступов
• snake_case для функций и переменных, CamelCase для классов

Clean Code

• Минимальные функции (~5–15 строк)
• Каждая функция делает одну вещь
• Чёткие имена переменных и функций
• Исключения вместо None для ошибок

Докстринги

• Для публичных классов и методов
• Указываем: Args, Returns, Raises, Examples (либо на русском - Примеры), Примечания
• GoogleStyle
• Придерживаемся правила "хороший код должен быть понятен без документации". Не нужно писать документацию на все подряд - постарайтесь написать код так, чтобы он был понятен и без них, но и при этом на что-то низкоуровневое, понятное только лишь узкому кругу людей - документацию писать нужно

Была ли статья полезна?

🙂 🙁

⬅ Главная Git и коммиты ➡