В доисторические времена Динозавру довелось написать много строчек кода. И вот какие мысли пришли Динозавру после осознания того, что код не совершенен.
Чистый и красивый код в программировании. Мысли вслух.
В доисторические времена Динозавру довелось написать много строчек кода.
И вот какие мысли пришли Динозавру после осознания того, что код не совершенен.
- Даже идеальный код можно улучшить, так называемый рефакторинг. Мысль про улучшение приходит сама, просто достаточно посмотреть на него ещё раз через день или через месяц. Но улучшать работающее нужно с пониманием причины улучшения, пониманием того, зачем это делать. Принцип "работает - не трогай" никто ещё не отменил.
- Комментировать код - священное правило, которое нельзя нарушать. Комментировать обязательно те куски кода, в которых происходит неочевидная МАГИЯ.
- Через какое-то время программист может забыть свой код. Комментарий должен описывать то, что делает код, а главное ЗАЧЕМ.
- Называть переменные нужно так, чтобы становилось понятно зачем эта переменная нужна, какие в себе значения хранит.
- Название функции/процедуры должно отражать суть действий без посторонних подсказок.
- Каждая функция должна выполнять одну уникальную функцию.
- Важно придерживаться единообразия названий: подчеркивания или заглавные буквы.
- Не используйте однобуквенные названия
Примеры нотаций для названий:
- camelCase - каждое слово, кроме первого, начинается с большой буквы.
- PascalCase - каждое слово с большой буквы
- kebab-case - слова через дефис
- snake_case - слова через нижнее подчёркивание
- Можно использовать и свои варианты для названий переменных, констант, функций, которые допустимы и/или соответствуют рекомендациям для конкретного языка.