Написание чистого кода — это навык, который должен освоить каждый программист. Дело не только в том, чтобы ваш код выглядел хорошо, но и в том, чтобы сделать его более удобным для сопровождения и более легким для чтения.

Принципы кода — это рекомендации, которые помогут вам писать лучший код. Это не правила, а скорее предложения, которые могут улучшить качество вашего кода.

Однако вам не нужно ждать, пока у вас будет идеальный код, чтобы начать применять эти принципы. Вы можете начать использовать их прямо сейчас в своем коде!

Вот несколько принципов кода, которые вы можете начать применять в своем коде прямо сейчас:

ПОЦЕЛУЙ (будь проще, глупый)

Принцип KISS — это хорошо известное правило, которое предполагает, что ваш код должен быть как можно более простым.

Не добавляйте ненужные функции или сложности в свой код. Придерживайтесь основ и добавляйте только то, что абсолютно необходимо.

Более того,

Не пытайтесь быть слишком умным. Сделайте свой код простым для понимания и легко изменяемым.

СУХОЙ (не повторяйтесь)

Принцип DRY — это еще одно руководство, которое предполагает, что вы должны избегать повторения в своем коде.

Не пишите один и тот же код несколько раз. Если вы обнаружите, что копируете и вставляете код, это признак того, что вам следует реорганизовать свой код.

YAGNI (Вам это не понадобится)

Принцип YAGNI — это руководство, которое предполагает, что вы должны добавлять только те функции, которые вам нужны.

Не добавляйте функции, которые, по вашему мнению, могут вам понадобиться в будущем. Добавляйте только те функции, которые вам нужны прямо сейчас.

ТВЕРДЫЙ

Принципы SOLID — это набор руководящих принципов, определенных Робертом С. Мартином (дядей Бобом). Они предполагают, что вы должны проектировать свой код определенным образом, чтобы сделать его более удобным в сопровождении и расширяемым.

Принципы SOLID заключаются в следующем:

Принцип единой ответственности: класс должен иметь одну и только одну ответственность.

Принцип открытости/закрытости: класс должен быть открыт для расширения, но закрыт для модификации.

Принцип замещения Лискова: производные классы должны заменять свои базовые классы.

Принцип разделения интерфейса. Клиентов нельзя заставлять зависеть от методов, которые они не используют.

Принцип инверсии зависимостей: полагайтесь на абстракции, а не на конкретику.

Принцип единой ответственности

Принцип единой ответственности (SRP) — это принцип кода, который гласит, что у класса или модуля должна быть одна и только одна причина для изменения.

Это означает, что у класса должна быть только одна ответственность, и эта ответственность должна быть полностью инкапсулирована классом.

Например, если у вас есть класс, который обрабатывает как доступ к базе данных, так и проверку ввода, тогда у этого класса будет две причины для изменения: когда изменится схема базы данных и когда изменятся правила проверки.

Вместо этого было бы лучше иметь два отдельных класса, один для доступа к базе данных и один для проверки. Таким образом, у каждого класса есть только одна обязанность и только одна причина для изменения.

SRP может применяться как к классам, так и к методам. У метода должна быть только одна ответственность, и эта ответственность должна быть полностью инкапсулирована методом.

Правило бойскаута

Правило бойскаута — это принцип кода, который гласит, что вы должны оставить код лучше, чем вы его нашли.

Это означает, что когда вы вносите изменения в часть кода, вы также должны воспользоваться возможностью, чтобы очистить любой другой код, с которым вы сталкиваетесь.

Например, если вы видите метод с неправильным названием, воспользуйтесь возможностью переименовать его. Или, если вы видите фрагмент дублированного кода, воспользуйтесь возможностью провести его рефакторинг.

Правило бойскаута — отличный способ постепенно улучшать кодовую базу с течением времени.

Последние мысли

Это все для этой статьи. Я думаю, что применение этих принципов к вашему коду может сделать ваш код лучше, читабельнее и понятнее. Вы можете применить эти принципы к своему коду прямо сейчас. Нетрудно применить эти принципы в вашем коде. Вам просто нужно более осознанно относиться к своему коду.

Спасибо за прочтение!