Написание чистого кода может существенно изменить нашу работу. В основном это приносит пользу, когда наша работа зависит от других в команде.
Представьте, что вы индонезиец, и вас заставляют читать, а также понимать греческий язык.
То же самое и с чтением чужого кода. Понять чужой код, скорее всего, невозможно, если владелец даже не пытается объяснить это через код.
Теперь я поделюсь своим опытом написания чистого кода для моего текущего проекта «Yuk-Recycle» в сотрудничестве с GO-JEK.
Принципы чистого кода
Есть несколько особенностей применения чистого кода. В разделе ниже я упомяну несколько функций, которые я реализовал в этом проекте.
Читаемость через выразительные имена переменных / функций
Это может стать самым большим поворотом в правилах написания чистого кода. Если мы напишем имена переменных достаточно ясно, нам, возможно, не придется писать для них документацию. Кроме того, не забывайте следовать лучшим практикам именования переменных в вашем собственном языке программирования / фреймворке.
Помните, что при написании имен переменных лучше называть их именами объектов. И, пожалуйста, никогда не пишите имя переменной одним символом, если это не переменная-итератор.
Во Flutter мы используем именование переменных Camel Case, поэтому лучше следовать лучшим практикам. Сделайте это выразительным с помощью наименования, убедитесь, что оно достаточно четкое, чтобы его могли прочитать другие.
С другой стороны, при написании имен функций лучше использовать имена глаголов. Когда мы знаем, что первое слово - это глагол, гораздо яснее заметить это как функцию.
В этом сегменте кода мы хотим создать функцию, которая могла бы стирать поле формы на странице входа и сбрасывать состояние до 0. Чтобы назвать функцию, просто назовите ее так, как она будет делать в соответствии с ее поведением, resetLoginForm.
Затем мы также хотим создать функцию, в которой функция меняет состояние на 1. Функция должна срабатывать каждый раз, когда мы нажимаем кнопку входа в систему. Мы просто называем его handlePressLoginBtn.
И последнее, но не менее важное: избегайте использования неоднозначных имен в коде. Например, в React у нас есть зарезервированное ключевое слово «State» в компоненте, а затем мы хотим записать некоторые имена атрибутов профиля человека. В адресе профиля указан штат (провинция), имя которого аналогично названию государства в React. Чтобы избежать этого конфликта, мы можем назвать атрибут адреса, начинающийся с «addr», так что состояние будет «addrState».
Избегайте написания комментариев
Это в основном связано с первым принципом. Наличие комментариев только делает ваш код более уродливым (что является обратным от того, что мы пытаемся сделать здесь). Не говоря уже о том, что если вы напишете комментарии или документацию по каждой логике, функционирующей в вашем коде, наступит время, когда вам понадобится изменить логику в некоторых функциях. Когда это произойдет, вам также необходимо обновить свои комментарии. Затем… это происходит довольно часто, и в конце концов мы можем начать забывать об обновлении наших комментариев. По сути, эти комментарии могут привести к ошибке.
Одно из решений избежать написания комментариев - написать код достаточно ясно, чтобы другие могли понять, просто прочитав ваш код.
Не повторяйся
Написание повторяющихся кодов - не лучший способ разработки программы. Это сделает ваш код глупым, если вы будете копировать один и тот же код снова и снова. Вместо этого мы могли бы упростить его, написав только один раз и импортируя или вызывая его всякий раз, когда мы хотим использовать его повторно.
Этот класс специально действует как обработчик для управления логическим состоянием входа в систему в нашем приложении. Состояние входа будет сохранено в объекте с именем SharedPreferences.
Состояние входа пользователя будет проверяться на каждой странице нашего приложения в целях безопасности. Вместо инициализации объекта SharedPreferences на каждой странице лучше оставить его вызываемым только один раз в этом классе поставщика входа. Затем мы можем использовать общедоступные методы для доступа к SharedPreferences на другой странице.
Вывод
Написание кода похоже на написание сборника рассказов. Нам нужно представить историю ясно и привлекательно для прочтения. Если вы напишете его небрежно, люди могут счесть его нечитаемым и не вдохновляющим.
Спасибо, что посетили мою статью!
