Не делай так: and в названии метода.
Если в названии метода есть and между глаголами - это признак того, что метод берёт на себя слишком много.
Простейший пример:
На самом деле это два метода, которые, как гномы из "Гравити Фолз", притворяются одним. Здесь нужна декомпозиция:
Помимо длинного названия подобные методы создадут много проблем:
- их сложно тестировать. Нужно покрывать все действия, происходящие внутри, поэтому тесты становятся огромными, а процесс их написания превращается в практику по комбинаторике;
- нельзя переиспользовать код. А что, если я в будущем захочу только валидировать пользователя?
- риск прячущихся жуков. При достаточной длине метода в нём могут прятаться баги, которых мы скорее всего не сможем обнаружить глазами.
Казалось бы - мелочь. Но я собственными руками рефакторил такой код. А как-то даже писал на него тесты, потому что зарефакторить спустя годы его существования уже являлось трудной задачей.
#неДелайТак - декомпозируй!
🎤 feelin #cleanCode
Если в названии метода есть and между глаголами - это признак того, что метод берёт на себя слишком много.
Простейший пример:
def validate_and_save_user(user: User):
...
На самом деле это два метода, которые, как гномы из "Гравити Фолз", притворяются одним. Здесь нужна декомпозиция:
def validate_user(user: User):
...
def save_user(user: User):
...
Помимо длинного названия подобные методы создадут много проблем:
- их сложно тестировать. Нужно покрывать все действия, происходящие внутри, поэтому тесты становятся огромными, а процесс их написания превращается в практику по комбинаторике;
- нельзя переиспользовать код. А что, если я в будущем захочу только валидировать пользователя?
- риск прячущихся жуков. При достаточной длине метода в нём могут прятаться баги, которых мы скорее всего не сможем обнаружить глазами.
Казалось бы - мелочь. Но я собственными руками рефакторил такой код. А как-то даже писал на него тесты, потому что зарефакторить спустя годы его существования уже являлось трудной задачей.
#неДелайТак - декомпозируй!
Please open Telegram to view this post
VIEW IN TELEGRAM
🔥4⚡1👨💻1
Не делай так: гигантский тернарный оператор
Тернарные операторы — отличный инструмент для небольших ветвлений. Ключевое слово здесь — небольших. Как только в них начинает проникать сложная логика, код быстро теряет читаемость.
Представьте, что вы встретили в коде вот такой фрагмент:
Чтобы понять его, приходится мысленно строить дерево как компилятор. А зачем? Ради экономии строк? Так теперь код выглядит ещё страшнее.
Более того, такой код ещё и становится хрупким. Любое изменение в нём — риск: легко нарушить логику, особенно если он не покрыт тестами.
А вот как тот же функционал может выглядеть с
Здесь всё последовательно и без раздувания когнитивной сложности. Да и ещё для расширения списка условий не придётся ломать голову.
#неДелайТак - не усложняй.
🎤 feelin #cleanCode
Тернарные операторы — отличный инструмент для небольших ветвлений. Ключевое слово здесь — небольших. Как только в них начинает проникать сложная логика, код быстро теряет читаемость.
Представьте, что вы встретили в коде вот такой фрагмент:
const renderButtonLabel = (
user: User | null,
cart: Cart,
isMobile: boolean,
hasUnreadNotifications: boolean,
currentRoute: string
): string =>
(user != null && cart.items.length > 0 && !cart.hasBackorderedItems && user.balance >= cart.total && !isMobile && !hasUnreadNotifications && currentRoute !== '/checkout')
? 'Перейти к оплате'
: (user != null && cart.items.length > 0 && cart.hasBackorderedItems)
? 'Часть товаров временно недоступна'
: (user != null && cart.items.length === 0)
? 'Корзина пуста'
: (user == null)
? 'Войдите, чтобы оформить заказ'
: (isMobile || hasUnreadNotifications || currentRoute === '/checkout')
? 'Продолжить'
: 'Готово';
Чтобы понять его, приходится мысленно строить дерево как компилятор. А зачем? Ради экономии строк? Так теперь код выглядит ещё страшнее.
Более того, такой код ещё и становится хрупким. Любое изменение в нём — риск: легко нарушить логику, особенно если он не покрыт тестами.
А вот как тот же функционал может выглядеть с
if:const renderButtonLabel = (
user: User | null,
cart: Cart,
isMobile: boolean,
hasUnreadNotifications: boolean,
currentRoute: string
): string => {
if (user == null) {
return 'Войдите, чтобы оформить заказ';
}
if (cart.items.length === 0) {
return 'Корзина пуста';
}
if (cart.hasBackorderedItems) {
return 'Часть товаров временно недоступна';
}
if (
cart.items.length > 0 &&
user.balance >= cart.total &&
!isMobile &&
!hasUnreadNotifications &&
currentRoute !== '/checkout'
) {
return 'Перейти к оплате';
}
return 'Продолжить';
};
Здесь всё последовательно и без раздувания когнитивной сложности. Да и ещё для расширения списка условий не придётся ломать голову.
#неДелайТак - не усложняй.
Please open Telegram to view this post
VIEW IN TELEGRAM
«Clean Claude»
Недавно наткнулся на Хабре на одну интересную штуку - пересказ серии твитов Роберта Мартина. В них он рассказывает о своём первом опыте от AI кодинга.
За несколько месяцев дядя Боб рассказал много всякого интересного. Например, что бесплатный Grok сильно тупил и не очень ему понравился, а вот платный Claude уже создаёт серьёзное ускорение для профессионала.
Самое примечательное — как Мартин встраивает ИИ в свою идеологию «чистого кода». Он утверждает: если вы владеете TDD и принципами SOLID, ИИ действительно ускорит вас и избавит от рутинных задач. При этом, по его мнению, принципы чистого кода не устарели — напротив, стали ещё актуальнее.
Главным выводом остаётся то, что нельзя отдавать процесс мышления на аутсорс ИИ. Человек всё ещё решает, что именно агенту нужно делать.
Для усиления контроля над ИИ можно использовать всё те же традиционные инструменты, хорошо подсвечивающие регресс или другие проблемы. Например, тесты или статические анализаторы. О том, как контролировать агентов, кстати, мы говорили с S0ER'ом в выпуске "Разбаговки" про ИИ. Вот ссылка, если не видели.
А сам перевод твитов дяди Боба можно найти здесь. Определённо рекомендасьон!
🎤 feelin #ai #cleanCode
Недавно наткнулся на Хабре на одну интересную штуку - пересказ серии твитов Роберта Мартина. В них он рассказывает о своём первом опыте от AI кодинга.
За несколько месяцев дядя Боб рассказал много всякого интересного. Например, что бесплатный Grok сильно тупил и не очень ему понравился, а вот платный Claude уже создаёт серьёзное ускорение для профессионала.
Самое примечательное — как Мартин встраивает ИИ в свою идеологию «чистого кода». Он утверждает: если вы владеете TDD и принципами SOLID, ИИ действительно ускорит вас и избавит от рутинных задач. При этом, по его мнению, принципы чистого кода не устарели — напротив, стали ещё актуальнее.
Главным выводом остаётся то, что нельзя отдавать процесс мышления на аутсорс ИИ. Человек всё ещё решает, что именно агенту нужно делать.
Для усиления контроля над ИИ можно использовать всё те же традиционные инструменты, хорошо подсвечивающие регресс или другие проблемы. Например, тесты или статические анализаторы. О том, как контролировать агентов, кстати, мы говорили с S0ER'ом в выпуске "Разбаговки" про ИИ. Вот ссылка, если не видели.
А сам перевод твитов дяди Боба можно найти здесь. Определённо рекомендасьон!
Please open Telegram to view this post
VIEW IN TELEGRAM
👍2
Проблемы с цепочками
В своих докладах о чистом коде я часто разбираю рефакторинг длинных цепочек вызовов. Основная мысль проста: такая конструкция не только замедляет чтение и понимание кода, но и бьёт по производительности.
Однажды меня спросили: "А что, если эти методы изменяют внутреннее состояние объекта?" Действительно, если
Но ответ, на мой взгляд, кроется в самой постановке вопроса. Хороший код не должен порождать сомнения в духе "а что, если...". Если безопасный синтаксический рефакторинг меняет логику работы — это не недостаток рефакторинга, а яркий сигнал о проблемном дизайне.
Если копнуть глубже, то использование методов с побочными эффектами в контексте извлечения параметров выглядит странным в принципе. Если в подобной ситуации на практике методы действительно меняют состояние, "лечить" нужно не цепочку вызовов, а архитектуру класса.
🎤 feelin #cleanCode
В своих докладах о чистом коде я часто разбираю рефакторинг длинных цепочек вызовов. Основная мысль проста: такая конструкция не только замедляет чтение и понимание кода, но и бьёт по производительности.
Однажды меня спросили: "А что, если эти методы изменяют внутреннее состояние объекта?" Действительно, если
audinfo() (ну или подобный метод в других примерах) возвращает объект, чьи методы мутируют состояние, то вынесение его в переменную превратит пять независимых вызовов в пять обращений к одному экземпляру. А значит, поведение программы может измениться.Но ответ, на мой взгляд, кроется в самой постановке вопроса. Хороший код не должен порождать сомнения в духе "а что, если...". Если безопасный синтаксический рефакторинг меняет логику работы — это не недостаток рефакторинга, а яркий сигнал о проблемном дизайне.
Если копнуть глубже, то использование методов с побочными эффектами в контексте извлечения параметров выглядит странным в принципе. Если в подобной ситуации на практике методы действительно меняют состояние, "лечить" нужно не цепочку вызовов, а архитектуру класса.
Please open Telegram to view this post
VIEW IN TELEGRAM
👍2
Привет!
Меня зовут Валерий Филатов, добро пожаловать в мой авторский канал. Здесь я пишу про разработку и технологии: разбираю интересные новости, думаю вслух, делюсь опытом.
Немного обо мне: работаю Developer Advocate и Project Lead в PVS-Studio — пишу код и тексты, выступаю, иногда рулю проектами.
Где ещё меня найти:
🗂 LinkedIn
😺 GitHub
✍️ Habr
Хэштеги для навигации:
#ai - новости и мысли об ИИ
#cleanCode - про качество кода и хорошие практики
#devrel - всякое про Developer Relations
#meme - без комментариев
#podcast - выпуски подкаста «Разбаговка»
#security - всякое про безопасность
#неДелайТак - антипримеры и разборы ошибок
🎤 feelin
Меня зовут Валерий Филатов, добро пожаловать в мой авторский канал. Здесь я пишу про разработку и технологии: разбираю интересные новости, думаю вслух, делюсь опытом.
Немного обо мне: работаю Developer Advocate и Project Lead в PVS-Studio — пишу код и тексты, выступаю, иногда рулю проектами.
Где ещё меня найти:
Хэштеги для навигации:
#ai - новости и мысли об ИИ
#cleanCode - про качество кода и хорошие практики
#devrel - всякое про Developer Relations
#meme - без комментариев
#podcast - выпуски подкаста «Разбаговка»
#security - всякое про безопасность
#неДелайТак - антипримеры и разборы ошибок
Please open Telegram to view this post
VIEW IN TELEGRAM
👍6✍1
Не делай так: повесть в комментариях
Огромная, как по мне, задача при написании чистого кода — это правильная работа с комментариями. Поскольку тема обширная, коснёмся лишь одного конкретного вопроса: размер имеет значение?
Ну, например, иногда я встречал в коде комментарии к методам, которые больше самих этих методов. И из самой формулировки, думаю, понятно, что это крайняя степень безумия.
Да, возможно, такой комментарий объясняет какую-то невероятно важную подробность. Но чаще всего: а) то же самое можно написать намного короче; б) скорее всего этот комментарий между строк говорит, что мы могли сделать нормально, но жизнь распорядилась иначе.
Из этого правила, естественно, есть исключения. Иногда, например, разработчики внешнего API, на котором завязан наш код, своими изменениями дают понять, что они те ещё дети сыновей. Но воспользуюсь клише и скажу, что исключения лишь подтверждают правило.
Но проблемы не только с большими комментариями! На другой стороне нашего глобуса безумия — рассказы про код, который сам себя документирует.
Мечтать — это нормально, а иногда даже полезно. Но при решении реальных задач зачастую не до идеальных решений. Нужно находить баланс между запросами бизнеса и профессиональной этикой, то есть делать свою работу нужно хорошо, не идеально. Поэтому оставлять комментарии — это нормально, даже хорошо.
Хороший комментарий — это не извинение за плохой код. Это помощь тому, кто придёт после вас. Иногда этим человеком будете вы сами через какое-то время. Но не забывайте, что вы сущность в коде описываете, а не дуб.
Поэтому #неДелайТак - пиши комментарии осмысленно!
P. S. А вообще тема большая, и явно не для формата коротенького поста. Рано или поздно придумаю, как бы рассказать всё про комментарии :)
🎤 feelin #cleanCode
Огромная, как по мне, задача при написании чистого кода — это правильная работа с комментариями. Поскольку тема обширная, коснёмся лишь одного конкретного вопроса: размер имеет значение?
Ну, например, иногда я встречал в коде комментарии к методам, которые больше самих этих методов. И из самой формулировки, думаю, понятно, что это крайняя степень безумия.
Да, возможно, такой комментарий объясняет какую-то невероятно важную подробность. Но чаще всего: а) то же самое можно написать намного короче; б) скорее всего этот комментарий между строк говорит, что мы могли сделать нормально, но жизнь распорядилась иначе.
Из этого правила, естественно, есть исключения. Иногда, например, разработчики внешнего API, на котором завязан наш код, своими изменениями дают понять, что они те ещё дети сыновей. Но воспользуюсь клише и скажу, что исключения лишь подтверждают правило.
Но проблемы не только с большими комментариями! На другой стороне нашего глобуса безумия — рассказы про код, который сам себя документирует.
Мечтать — это нормально, а иногда даже полезно. Но при решении реальных задач зачастую не до идеальных решений. Нужно находить баланс между запросами бизнеса и профессиональной этикой, то есть делать свою работу нужно хорошо, не идеально. Поэтому оставлять комментарии — это нормально, даже хорошо.
Хороший комментарий — это не извинение за плохой код. Это помощь тому, кто придёт после вас. Иногда этим человеком будете вы сами через какое-то время. Но не забывайте, что вы сущность в коде описываете, а не дуб.
Поэтому #неДелайТак - пиши комментарии осмысленно!
P. S. А вообще тема большая, и явно не для формата коротенького поста. Рано или поздно придумаю, как бы рассказать всё про комментарии :)
Please open Telegram to view this post
VIEW IN TELEGRAM
👍3🔥2