digital-garden/dev/Читаемый код.md

38 lines
4.0 KiB
Markdown
Raw Normal View History

2024-10-20 20:19:00 +03:00
---
aliases:
- читаемость кода
- читаемости кода
2024-11-03 22:27:39 +03:00
- читаем код
2024-11-24 11:44:57 +03:00
- код пишется для людей, а не для машин
- понимания кода
2024-10-20 20:19:00 +03:00
tags:
- maturity/🌱
- content/opinion
date: 2024-10-20
---
2024-11-24 11:44:57 +03:00
Код — это не просто набор инструкций для машины, но и средство коммуникации между разработчиками. ==Программисты проводят большую часть времени, читая чужой код.== Поэтому каждый фрагмент кода должен быть понятен не только автору, но и другим членам команды. Удобочитаемость и понятность кода для коллег — ключевые факторы успешной [[../productivity/Эффективная команда разработки|командной работы]].
2024-10-20 20:19:00 +03:00
2024-11-24 11:44:57 +03:00
Хорошо написанный код снижает [[efficiency/Снижение когнитивной нагрузки при разработке|когнитивную нагрузку]] на разработчиков. Любой может написать код, который поймёт компьютер. ==Хорошие программисты пишут код, который понятен людям.== Если ваш код понятен только вам и не может быть поддержан другими, это явный сигнал того, что вы не справляетесь с задачей качественного написания кода.
2024-10-20 20:19:00 +03:00
**Рекомендации**:
- **Пишите просто и ясно**. Используйте понятные и распространённые конструкции языка, которые легко читаются и понимаются коллегами.
2024-11-03 13:46:19 +03:00
- **Не усложняйте**. Не стремитесь использовать сложные или малоизвестные возможности языка, если они не приносят очевидной пользы. ==Простота всегда предпочтительнее.==
2024-11-24 11:44:57 +03:00
- **Комментируйте важные моменты**. Там, где логика может быть неочевидной, добавьте [[Комментарии в коде|комментарии]], которые объясняют цель или обоснование ваших решений.
- [[efficiency/Стандартизация подходов в разработке|Стандартизация подходов в разработке]]. Соблюдайте единые стандарты кодирования, принятые в команде, будь то соглашения о стиле, именовании или форматировании.
- Используйте [[efficiency/Соглашение о наименовании|осмысленные имена]]. Переменные, функции и классы должны иметь названия, которые чётко отражают их назначение. Избегайте сокращений, если они могут быть непонятны другим.
2024-10-20 20:19:00 +03:00
- **Проводите регулярные ревью кода**. Обратная связь от коллег помогает выявить возможные сложности в понимании кода и улучшить его качество.
***
## Мета информация
**Область**:: [[../meta/zero/00 Разработка|00 Разработка]]
**Родитель**::
**Источник**::
**Создана**:: [[2024-10-20]]
**Автор**::
### Дополнительные материалы
-
### Дочерние заметки
<!-- QueryToSerialize: LIST FROM [[]] WHERE contains(Родитель, this.file.link) or contains(parents, this.file.link) -->