Мы пишем имена везде в программном обеспечении. Вот почему именование чрезвычайно важно при написании чистого кода. Итак, ниже приведены некоторые важные советы по именованию ваших переменных во время написания вашего следующего замечательного программного обеспечения.
Раскройте намерения. Имя переменной, класса и функции должно отвечать тому, почему эта переменная была создана, что она делает и как используется. Если ваше имя требует комментария, то это неправильное имя переменной.
Примеры плохих имен: -
const d = 3; // elapsedDaysInTime const performOperation = (a, b) => a + b;
Примеры хороших имен: -
const elapsedDaysInTime = 3; const add = (a, b) => a + b;
Избегайте дезинформации. Имена переменных не должны распространять дезинформацию. например
const actorsList = { micheJackson: {}, tomCruise: {} }
в приведенном выше примере actorsList — это объект, который приводит к неправильной информации, поскольку программисты могут рассматривать его как массив. Лучшим решением было бы просто назвать переменную как actors.
Избегайте близких имен: сколько времени требуется, чтобы отличить XYZControllerForEfficientHandlingOfStrings от XYZControllerForEfficientStorageOfStrings? Вы должны избегать имен, которые настолько близки друг к другу, что программисты, читающие ваш код, могут запутаться.
Используйте произносимые имена. Люди легко запоминают то, что легко могут сказать. Слова, которые нельзя произнести, трудно запомнить и обдумать. Рассмотрим ниже примеры: -
const calcAge = (curYear, dob) => curYear - dob; const calculateAge = (currentYear, dateOfBirth) => currentYear - dateOfBirth;
Итак, какой из них легче использовать в вашей программе?
Не используйте числа или строки напрямую. Часто программисты читают код, но не понимают, почему в нем упоминается это число. Например,
if (students > 7) { // do something }
Теперь, что это за 7? Вместо того, чтобы писать приведенный выше код, мы могли бы сделать что-то, как показано ниже.
const MAX_STUDENTS_PER_CLASS = 7; if (students > MAX_STUDENTS_PER_CLASS) { // do something }
делает код более читаемым, не так ли?
Имена классов. Имена классов должны быть существительными с регистром паскаль, такими как «Клиент», «Сотрудник», «Студент» и т. д. Избегайте таких имен, как «Процесс», «Данные» и т. д.
Имена методов. Имена методов должны состоять из глаголов или глагольных фраз, таких как postPayment, deletePage, save и т. д.
Так что надеюсь, вы получили некоторое представление о лучших практиках именования переменных. Если у вас есть какие-либо предложения, не стесняйтесь добавлять их в комментариях ниже. Пожалуйста, хлопайте, если вам понравился материал. Вы можете прочитать больше моих блогов на моем сайте https://blog.csschool.io/