10 Советов по написанию чистого кода
Речь идет о написании хорошего и читаемого кода, большом рефакторинге для достижения лучших результатов, оптимизации, структурировании, организации, анализе требований пользователей, проектировании, построении, тестировании и т.д... поверь мне, это не закончится
В этой статье я поделюсь своим опытом написания чистого кода, любой может изучить новую технологию и внедрить ее, но мы всегда должны следовать лучшим практикам и обращать внимание на мелкие детали 😊
Я разделю процесс на 10 шагов (постараюсь сделать каждый пункт как можно короче и надеюсь, что это прояснит или поможет вам стать лучше в вашем путешествии по кодированию)
1 - Простой и читаемый
Мой код должен младший и старший понимать его, называя, структурируя ваш код простым и читаемым способом, который облегчит вашу жизнь раньше, чем другие
Под простым я подразумеваю прямое, легкое и охватывающее цель, где в то же время будет читабельно
2 - Наличие собственного стандарта
Найдите свой собственный стиль и стандарт это повысит вашу производительность, особенно когда вы имеете дело с несколькими проектами
Это позволит вам быстрее вносить изменения или обновлять основную часть кода
3- SRP (Принцип единой ответственности)
Функция, которая выполняет все, это буквально головная боль
Давайте сделаем наши функции ответственными за одну задачу, это сделает вашу функцию чистой и понятной, масштабируемой и намного более гибкой. И постарайтесь, чтобы аргументов внутри функции было как можно меньше
4 - Избегайте комментариев
Избегайте комментирования старых функций или старого кода (для решения этой главной проблемы 😉 )
Избегайте комментариев, чтобы указать назначение строки или "что она делает"
Ваш код не должен нуждаться в комментариях, чтобы быть понятным
Только напишите комментарий, если у вас есть что-то, связанное с третьей стороной, и сделайте его как можно короче (цель этого - прояснить ситуацию для другого разработчика), но опять же, даже если вы используете сторонний API, ваш код должен быть простым и прямым, новый разработчик может получить доступ к документации и разобраться во всем, поэтому здесь тоже нет необходимости комментировать
5 - Ваш код должен быть простым для других
Давайте сделаем код как можно проще, и хотя упрощение вашего кода на самом деле является процессом его оптимизации
Будьте прямолинейны и всегда думайте о других (это читаемо? поймут ли они это? смогу ли я через 2 недели?)
6- Пробелы и отступы
Многие люди думают, что использование дополнительных из них затруднит чтение или даже повлияет на компилятор 😄
Я рекомендую использовать как можно больше.
7 - Организуйте свой проект
Хорошая структура папок и легкий доступ к файлам - это просто идеальное значение для счастливой жизни 🌴
Структурируйте свой код так, чтобы другие могли легко искать папки и файлы, сделайте его максимально готовым к масштабированию и организации
8- Значимые и прямые имена
Во время кодирования вы будете писать множество имен для переменных, функций, классов, аргументов, модулей, пакетов, каталогов и т.д...
Хорошей практикой будет написать чистый, простой для понимания и просто осмысленный код.
9 - Избегайте повторений
Всегда убедитесь, что ваш код является многоразовым и масштабируемым
Разбейте задачу на более мелкие части и убедитесь, что по крайней мере 90 % ее можно использовать повторно
10-Рефакторинг
Читайте другие коды, оптимизируйте их и делайте их чище. Мне нравится использовать термин "сжимать", что означает делать его проще и меньше
Рефакторинг кода - это действительно хороший навык, он поможет вам понять, что происходит, и пока вы проводите рефакторинг, он станет лучше, всегда полезно вернуться к вашему коду через некоторое время и улучшить его
