Чистый код - это код, который легко понять и легко изменить.
Я выбираю этот заголовок, поскольку многие люди, имеющие опыт работы в сфере технологий и программирования, на протяжении всего своего путешествия интересуются вопросом Действительно ли мой написанный код чист?
Людям необходимо понимать код, который мы пишем, мы можем сказать, что код, который мы пишем, предназначен не только для компьютера, но и для людей.
Программирование - это искусство сообщать другому человеку, что он хочет от компьютера.
- Дональд Кнут
Я, как программист, много раз задавал себе этот вопрос. Итак, давайте посмотрим правде в глаза сегодня. Давайте попробуем понять, что такое чистый код на самом деле, и узнать статус того, что мы писали со времен учебы в колледже. Пройдя по правилам написания чистого кода, оставьте комментарий относительно статуса вашего кода до сих пор?
Вот советы, которым нужно следовать, чтобы писать чистый код.
- Номенклатура. Одна из наиболее важных частей нашего кода - это то, как мы присваиваем имена нашим переменным. Самый большой фактор, влияющий на читабельность нашего кода, - это то, как мы даем имена нашей переменной. Всегда используйте осмысленные, описательные и произносимые имена для своих переменных, чтобы не ухудшать читаемость кода.
- Функции. Во-первых, функции должны указывать, что они делают, т.е. номенклатура функции очень важна. Во-вторых, помните, что это один из самых важных советов / правил разработки программного обеспечения, т. е. Одна функция должна выполнять не более одной задачи. В-третьих, избегайте передачи более двух аргументов в функции. Это сделало бы функцию сложной. Однако сложнее тестировать / отлаживать сложные функции.
3. LOC (строки кода): многие инженеры-программисты ошибочно считают, что небольшой код чище, чем длинный. Это не всегда верно. LOC не оказывает прямого влияния на чистоту кода. Иногда длинный код более читабелен и понятен по сравнению с коротким.
4. Комментарии. Многие из нас, должно быть, сталкивались с ситуацией, когда через долгое время мы читаем собственный или чужой код и не можем получить то, что на самом деле пытается сказать этот код. Это связано с двумя причинами:
а. Кодовая номенклатура очень плохая.
б. Отсутствие комментариев там, где это необходимо.
Комментарии очень важно писать, так как они помогают понять, что делает фрагмент кода. Но, конечно, мы можем до некоторой степени сократить написание комментариев, если сосредоточимся на номенклатуре. Так как это улучшит читаемость и поможет разобраться в коде без комментариев.
Если вы будете следовать вышеупомянутым методикам, вы на шаг опередите написание чистого кода. Не похоже, что вы сможете написать окончательный чистый код с одной попытки. Это бесконечный процесс, поскольку вы можете до некоторой степени реорганизовать свой код за несколько итераций и сделать его более чистым и читабельным.
В этом посте я попытался объяснить, что для меня значит чистый код, а также, надеюсь, убедил вас, что вам также следует позаботиться о методах чистого кода (если вы этого не делали раньше).
Чистый код всегда выглядит так, как будто его написал кто-то неравнодушный. Нет ничего очевидного, что можно сделать, чтобы улучшить его.
- Майкл Фезерс
