Лучшие практики для более понятного и организованного кода
Написание кода, который могут понять не только компьютеры, но и люди (и под людьми мы подразумеваем программистов), является важным навыком, которым должен обладать каждый программист. Если вы являетесь частью большой команды разработчиков, или работаете над программным обеспечением с открытым исходным кодом, или даже являетесь индивидуальным разработчиком, который работает над долгосрочным проектом, написание чистого и понятного кода будет иметь огромное значение для вас. и выделит вас среди других программистов.
И сегодня мы поделимся 10 советами по написанию чистого и понятного кода:
1. Именование переменных:
Это один из самых важных советов, которые сделают ваш код сверхчитаемым, мы все привыкли называть переменные таким образом, когда начали учиться программировать: i, j, x, y ... Это нормально использовать этот способ именования переменных если вы учитесь, потому что ваши программы не будут передавать 30 строк кода, и вы знаете, для чего объявлена каждая переменная, но когда вы начнете писать все больший и больший объем кода, это соглашение об именах будет неэффективным, и вы начнете терять отслеживание своего переменных, и в этом случае вам нужно начать выбирать хорошо описательные имена, такие как username, itemPrice, number_of_likes ... таким образом вы можете сказать, для чего будет использоваться каждая из этих переменных и что вы ожидаете от вашего кода в следующих двух строк, поэтому постарайтесь сделать имена переменных длиннее и нагляднее.
2. Ваши функции должны выполнять одну-единственную задачу:
Функции - очень важная концепция в программировании, они сделают ваш код СУХИМ (D вместо R повторить Y сам) и заставят его очень читабельно, если правильно применить эту концепцию. Когда вы начинаете писать функции, имейте в виду, что вам нужно спроектировать их так, чтобы они выполняли только одну вещь, и под одним мы подразумеваем только одну вещь, чтобы прояснить ситуацию, давайте посмотрим на этот пример:
В этой функции мы сначала проверяем тип операции, а затем выполняем ее, чтобы сделать ее более чистой и понятной, мы можем сделать это следующим образом:
Я знаю, что это немного экстремальный пример реализации принципов чистого кода, но когда ваш код начнет становиться все больше и больше, вы увидите преимущества использования этого метода и всегда помните, что ваши функции должны выполнять одну вещь, только одну-единственную вещь.
3. Функции присвоения имен:
Как и переменной, присвоение вашим функциям собственного имени сделает ваш код очень чистым, потому что он скажет любому, кто читает ваш код, чего ожидать от этой функции, и всегда помните, что имена ваших функций должны быть глаголами, например addTwoVariables, login_user, filterArray…
4. Делайте файлы как можно меньше:
Я почти уверен, что вы сталкиваетесь с ситуацией, когда очень сложно добавить одну функцию в один из больших файлов, которые вы написали, и поэтому нам всегда нужно сохранять количество строк внутри файла как можно меньшим, а также сделайте его предназначенным для обслуживания одной вещи (или, может быть, одной функции), а также вам нужно правильно назвать свои файлы и поместить их в файл с очень описательным именем, таким образом вы будете точно знать, куда смотреть при поиске фрагмент кода, а также расскажет другим, кто прочитает ваш код, чего ожидать в каждом файле.
Это несколько быстрых советов, которые улучшат качество и читаемость вашего кода, если вы примените их правильно, и теперь я надеюсь, что эта короткая статья вызвала ваше восхищение, и благодарю вас за внимание.
