Как написать чистый код? Следуйте этим рекомендациям

Знайте лучшие практики написания чистого кода.

Привет, программисты, эта статья не о некоторых функциях или концепциях, связанных с Java, а о большем. По сути, я собираюсь объяснить все ошибки, которые совершает Java-разработчик при написании кода, и, следовательно, как вы можете минимизировать их, и вам не нужно реорганизовывать свой код. Итак, эта статья посвящена НАИЛУЧШИМ ПРАКТИКЕ, которому разработчик всегда должен следовать.

1. Что в названии:

Разработчик всегда должен стараться дать осмысленное имя переменным, методам и классам. Когда кто-то читает ваш код, просматривая или отлаживая его, становится слишком легко понять, что это за метод, класс или переменная. Присвоение переменной таких имен, как a, b, c, не имеет никакого смысла и становится менее актуальным при отладке кода.

1.Всегда начинайте имя класса с верхнего регистра. Например.

public class Employee {
}

здесь Сотрудник - это имя класса, и другие разработчики могут легко понять, что этот класс имеет дело с вещами, связанными с сотрудниками.

2. Всегда начинайте имя переменной с нижнего регистра. Например.

private int salary;

здесь зарплата говорит о зарплате сотрудника.

3.Всегда начинайте имя метода с нижнего регистра и не включайте слова And и Or в имени метода. Например.

public int calculateSalary(int noOfDaysWorked , int baseSalary)

4. Пишите константы в верхнем регистре и разделяйте их знаком подчеркивания. Например.

public final int RETIREMENT_AGE = 58;

Примечание: не используйте специальные символы при написании имен переменных, методов, констант или классов.

2. Меньшие методы, которыми лучше управлять и отлаживать:

Написание множества вещей в одной функции приводит к плохой реализации дизайна. Кроме того, не рекомендуется писать слишком большие методы, поскольку их сложно отлаживать, если в одной функции выполняется так много всего. Следовательно, напишите свою функцию между 10–15 строками, сосредоточив внимание на одной вещи, которую выполняет метод.

3. Постарайтесь сократить количество строк кода:

Всегда пытайтесь подумать, прежде чем даже начнете писать какой-либо фрагмент кода. Также подумайте, есть ли возможность уменьшить количество строк, которые вы хотите написать. Как правило, разработчики проверяют логическое условие в блоке if и затем возвращают значение. Это неправильный способ писать код. Позвольте мне объяснить с помощью фрагмента кода для лучшего понимания.

boolean isContractor(Employee employee)
{ 
     if(employee.isCtr){
           return true;
     }
     else {
           return false;
     }
}

приведенный выше код можно сократить до:

boolean isContractor(Employee employee)
{
       return employee.isCtr;
}

Как видите, мы сократили код до одной строки вместо шести.

4. Нужны ли комментарии?

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

5. Одна задача в одном методе

Объединение множества задач / вещей в один метод - не лучший дизайн. Поэтому разработчики всегда должны стараться поддерживать разные функции для выполнения разных задач. Например.

public void addUser(String userName , String password)
{
//perform user addition operation to DB 
}

6. структурируйте свой код

Всегда пишите функции в порядке их вызова. Кроме того, напишите все переменные в начале всех методов, чтобы их было легче найти. Если некоторые переменные используются только в одной функции, попробуйте сделать эти переменные локальными переменными для этой функции.

7. рецензентам не нравится повторяющийся код.

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

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

8. проверьте работоспособность своего кода, написав тестовые примеры.

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

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

9. Не делайте жесткого кода

Жесткое кодирование - плохая идея, и я обычно вижу, что многие разработчики делают это при кодировании. Если вы жестко кодируете некоторые строки, становится сложно протестировать реализованные вами функции. Это может привести к ошибкам в вашем коде, если что-то изменится, связанное с вашим кодом.

private static String serverIpAddress =”1.2.3.4”;

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

10. Ведение журнала упрощает отладку кода.

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

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

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

11.Уменьшить параметры метода

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

Eg.

public void addUser(String name , String gender , String age ,String userName , String password)
{
//perform user addition operation to DB
}

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

public void addUser(User user)
{
//perform user addition operation to DB
}
//where user will be a class 
class User{
private String name ;
private String gender ;
private int age ;
private String userName;
private String password;
//here we can have constructors and getters and setters for above instance variables 
}

Вы можете видеть, как легко стало читать аргумент, переданный функции.

12. Повторное использование кода

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

13.END ПРИМЕЧАНИЕ

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

Вы можете использовать плагин SonarLint для Eclipse и IntelliJ IDE для улучшения качества вашего кода. Этот плагин подскажет вам, что лучше всего практики при написании кода.

Если вы найдете эту статью полезной, то можете Подписывайтесь на меня за такими полезными статьями.

Вы можете проверить другие мои статьи по языку программирования Java…