В языке программирования выбор правильного имени переменной является одним из важных правил большого пальца. В начале программирования мы не считаем это хорошей практикой. Но когда кодовая база становится больше и над ней работает гораздо больше разработчиков, становится все труднее управлять и координировать наши усилия. Наш код - это наше творение, поэтому мы должны как минимум правильно назвать его. Итак, потратив некоторое время, вы также поймете, что выбор правильного имени переменной очень полезен и повышает точность программирования. Это уменьшит путаницу, если мы правильно определим именование переменных.
Советы по хорошему именованию переменных
- Не используйте зарезервированные слова: не используйте «зарезервированные слова» каких-либо языков программирования. «Зарезервированные слова» - это заранее определенные слова, уже используемые этим языком.
Например: int, for, break, case, default, switch и т. д.
- Добавить комментарий. По возможности всегда добавляйте комментарий, если эта переменная использовалась в нескольких местах. Комментарий будет использоваться для определения использования этой переменной и улучшения читаемости. Комментирование - хорошая практика во всех языках программирования.
- Не используйте слишком длинные имена переменных. Длинные имена сделают код некрасивым и трудным для чтения, а также могут не работать на некоторых компиляторах из-за ограничения количества символов. Поэтому не используйте для переменных более 30 (макс.) символов.
- Используйте значимое имя: всегда используйте значимое имя, объясняющее значение этой переменной.
Например: счетчик, statusFlag, userList.
- Используйте регистр верблюда. Всегда используйте регистр верблюда при определении переменной. «Верблюжий регистр» объединяет слова, используя все слова, следующие за первым словом, с заглавной буквы и удаляя пробел.
Например: userList, employeeList, productList, employeeSalary и т. д.
- Не используйте беспорядок, например «_» и «-»: Не используйте «_» или «-» в именах переменных. Всегда старайтесь использовать верблюжий футляр.
Например: employee_salary, _emp и т. д.
- Не используйте повторно одно и то же имя переменной. Не используйте повторно одно и то же имя переменной в одном классе в разных контекстах, например в методе, конструкторе, классе. Таким образом, вы можете обеспечить большую простоту для понимания и удобства обслуживания.
- Определить константу заглавными буквами: всегда определять константу заглавной буквой. Если ваше постоянное имя содержит более одного произведения, используйте «_», чтобы объединить их.
Например: «MAX_SALARY», «TOTAL_PAGE», «MAX_PAGE» и т. д.
- Использовать имя столбца поля базы данных в форме HTML: В форме, в которой вы определяете весь свой HTML, попробуйте использовать то же имя поля, которое вы использовали в таблицах базы данных. Таким образом, это уменьшит отображение поля перед сохранением его в базе данных.
- Управление согласованностью. Соблюдайте стандарты языков программирования и не используйте символы верхнего и нижнего регистра непоследовательно.
Например: имя пользователя, имя пользователя, имя пользователя и т. д.
- Используйте общие глаголы, например is, has, can или do: у N есть логических переменных и методов с is, has и can улучшить читаемость кода. Такие методы, как isEmployee (), hasAccount (), canExecute (), добавляют большую ценность. Вы можете использовать то же правило для именования логической переменной, которую легко читать, если поместить ее в условный оператор, например
if (hasAccount) {
}
Как правило, переменной длины может быть 1 символ для счетчиков циклов, 1 слово для переменных условий / цикла, 1–2 слова для методов, 2–3 слов для классов, 3–4 слов для глобальных переменных . В разных организациях используются разные стандарты именования переменных. Поэтому всегда соблюдайте стандарты именования организации и последовательно записывайте имена переменных в приложении: например, txtUserName, lblUserName, cmbSchoolType,… В противном случае читабельность снизится, и инструменты поиска / замены будут непригодны для использования.
