Писать чистый и читаемый код не является легкой задачей. Требуется, чтобы вы продолжали читать о хороших практиках и применить их столько, сколько сможете избежать плохих.
Сегодня мы собираемся поговорить о преимуществах одной из этих практик, чтобы понять их важность. Но прежде чем прикоснуться к этому, давайте понять, что означает, что означают соглашения на именование.
Соглашения о именах – это некоторые правила, которые помогают вам назвать вещи в вашем коде, таком как переменные, функции и классы.
Одним из распространенных соглашений об именах, которые принимаются многими языками программирования, такие как Java, является Чехол верблюда Отказ В Чехол верблюда Вы называете ваши переменные и функции следующим образом mynameisawesome. . Первое слово начинается с строкой буквы, за которой следует столько слов, сколько вы хотите, но начинаются с заглавных букв.
Питон и подобные языки, такие как Ruby принимают другую конвенцию именования, которая является Снейк чехол my_name_is_awesome. . Вы можете четко сказать разницу между Чехол верблюда и Снейк чехол Отказ
Теперь пришло время понять, почему именованные вещи в вашем коде очень важно. Вы можете увидеть его как тривиальную задачу без преимуществ, и вам не нужно заботиться об этом. Но поверьте мне, это не пустая трата времени, как выглядит.
Единый стиль повышает читаемость
Представьте себе большой проект с сотнями разработчиков, которые участвуют. Если каждый разработчик решил назвать переменные и функции со своим собственным стилем, проект будет беспорядок.
Разработчики, которые следуют тому же Конвенции о именовании по всему проекту, способствуют его читабельности. Проект будет выглядеть так, как будто он был написан одним человеком.
Дифференцировать предметы по их именам
Еще одно преимущество следующих соглашений о именовании, которые также способствуют читаемости проекта, состоит в том, что вы можете легко различать предметы по именам. Например, если в Java вы найдете элемент, который назван в Чехол верблюда митем , это означает, что это переменная, объект или метод. Если он назван в Pascal Case Митем , это означает, что это класс. Если он назван в Кричащий змеиный чехол My_item , это означает, что это постоянное.
public class Circle {
private static final double PI = 3.14;
private double radius;
public Circle(double radius) {
this.radius = radius;
}
public double getArea() {
return PI * radius * radius;
}
}
public class Main {
public static void main(String[] args) {
Circle circle = new Circle(5);
double area = circle.getArea();
System.out.println(area);
}
}
Поиск становится проще
После Конвенции именования позволяет вам легко искать предметы в проекте. Если например, вы хотите найти метод, который отвечает за аутентификацию пользователей, вы ожидаете найти его с именем авторизоваться или войти для Чехол верблюда соглашение.
Та же идея применяется, когда вы используете встроенный класс, например ArrayList в Яве. Если вы хотите найти размер ArrayList объект, вы ожидаете найти метод с именем Длина или размер .
Больше сосредоточиться на необходимых деталях
Время является одним из самых ценных ресурсов, если не самым ценным. Когда дело доходит до программного обеспечения проектов, мы всегда хотим достичь больше за меньшее время. Для этого мы сделали повторяющиеся задачи, такие как название вещей намного быстрее. Как вы можете видеть, следуя соглашению об именах языка программирования, которую мы используем, могут способствовать этому. При этом мы сокращаем дебаты среди разработчиков о наилучшей Конвенции о именовании, потому что мы следуем стандарту. Другими словами, мы позволяем разработчикам сосредоточиться на необходимых деталях.
Конвенция о конфигурации
Конвенция о конфигурации Conventer – это парадигма проектирования программного обеспечения, используемая программными каркасами, которые пытаются уменьшить количество решений, которые требуется разработчик, использующий структуру, не обязательно потери гибкости. Википедия
Просто, Конвенция о конфигурации это подход, который используется современными каркасами. Это имеет дело с вами. Если вы будете следовать соглашениям о том, что рамки принимают, структура автоматически выполнит задачи конфигурации для вас. В противном случае вам придется сделать их вручную самостоятельно и потерять это преимущество.
Например, рамки могут до вас назвать ваши классы в Pascal Case соглашение об именовании Пользователь так что он может автоматически создать соответствующую таблицу в базе данных с именем Пользователи для тебя. Если вы решили назвать класс с другим Конвенцией именования __USER Рамки не будут делать задачу отображения для вас, и вы должны написать некоторые конфигурации, чтобы правильно создать таблицу. Это потому, что вы не следили за конвенциями, что рамки принимают.
Теперь вы понимаете, почему следующие соглашения о именовании необходимы, и хотя кажется тривиальной задачей, она действительно способствует вашим проектам.
Если вы знаете любое другое преимущество для следующих конвенций именования, пожалуйста, поделитесь этим с нами.
Оригинал: “https://dev.to/amrsaeedhosny/some-reasons-why-you-should-follow-naming-conventions-3k33”