Набор рекомендаций, которым вы можете следовать, называя вещи в программировании
Вы назвали переменную или функцию и забыли. Вы что-то вводите и ждете, пока автозаполнение завершит вас. Иногда даже это не удается. Наконец вы посмотрите это. Признаемся, все мы были там.
По понятным причинам называть вещи одним из самых сложных дел. Звучит просто, но это не так.
В этом посте давайте рассмотрим эту проблему. Конечно, я не собираюсь давать вам имена для каждой переменной или функции, которую вы пишете. Но мы рассмотрим набор рекомендаций, которые помогут вам улучшить свои навыки именования.
Давай нырнем
Переменные - это существительные
В большинстве случаев мы застреваем при выборе имени переменной. Когда вы называете свою переменную, убедитесь, что она читается как существительное. Поскольку переменные содержат некоторые данные, эти данные должны иметь имя (например, существительное).
Функции / методы - это глаголы
Мне сложно назвать функции / методы. Называть функции / методы глаголами полезно, потому что они таковы. Когда вы создаете функцию, вы что-то делаете в этой функции. Это может быть обновление значения переменной, выборка некоторых данных, сохранение некоторых данных и т. Д. Что бы это ни было, это действие (т. Е. Глагол).
Назовите логические значения положительно
Иногда мы используем логические значения для представления состояния действия. Например, isValid, isLoading, isComplete и так далее. Всегда лучше называть логические значения положительно. Всякий раз, когда вам нужно обратное, вы можете использовать Оператор отрицания, которым в большинстве языков программирования является !.
Дифференцировать членские / частные переменные
Всегда разделяйте переменную-член / частную переменную, добавляя к ней префикс. Некоторые люди добавляют к переменной-члену / частной переменной префикс m. Например, если вы хотите, чтобы имя вашей переменной было size, и оно было закрытым. Добавьте к нему префикс m, например, mSize.
Зачем это делать? Вы можете посмотреть на имя переменной и определить, является ли оно частным или нет, а также это помогает с автозаполнением. Некоторые языки программирования уже следуют этому. Например, в dart, чтобы создать частные переменные или функции, вы должны добавить к имени префикс _.
Можно использовать длинные имена
Используйте описательные имена, ничего страшного, если они будут длинными. Длинное описательное имя лучше, чем короткое и бессмысленное. Допустим, вы назвали переменную a, примерно через 3 месяца вы пересматриваете этот код и видите a. Теперь вы смотрите на это и думаете, что такое, черт возьми, a. Если бы вы назвали его лучше, например orderWithCharges. Глядя на код, вы поймете, что происходит, просто по названию.
Дело имеет значение
Мы не можем использовать пробелы между именами в программировании. Что привело к созданию футляров для нейминга. Среди самых известных - PascalCase, camelCase, kebab-case и snake_case. Придерживайтесь одного случая, не путайте много случаев. Что вы можете сделать, так это использовать один регистр, скажем, PascalCase, для именования файлов и классов, а затем camelCase для переменных и функций. Но не называйте одни переменные в одном, а другие - в другом. Пожалуйста, не надо.
Используйте имена в единственном числе
По возможности придерживайтесь единственного числа и избегайте использования множественного числа. Это применимо ко всему, что вы называете в программировании. Например, переменная, функция, метод, класс, таблица и т. Д. Поначалу это может показаться немного странным. Но придерживайтесь этого некоторое время, вы увидите, что имена запоминать легче. Например, вместо того, чтобы называть ваш список элементов items, назовите его itemList, потому что это список элементов. И вместо того, чтобы называть таблицу базы данных пользователей users, назовите ее user.
Быть последовательным
Если бы вам пришлось следовать только одному правилу, это было бы следующее: БУДЬТЕ ПОСЛЕДОВАТЕЛЬНЫ. Придерживайтесь принятых вами соглашений и применяйте их в своем проекте. Хорошая идея - обсудить это со своей командой и решить, что все будут на одной странице.
На этом пока все. Надеюсь, это помогло вам улучшить свои навыки именования и узнать что-то новое.
Спасибо за прочтение.
