Читаю сейчас книгу Чистый Код – Роберта С. Мартина и решил оставить несколько заметок о том, как более читаемо давать имена переменным.
В целом имя переменной должно отвечать на следующие вопросы:
- зачем она создана
- что она делает
- как она используется
Примеры хорошо озаглавленных переменных:
int elapsedTimeInDays;
int daysSinceCreation;
int daysSinceModification;
int fileAgeInDays;
Еще одна хорошая практика – не указывать в имени переменной ее тип и не использовать слова, которые могут быть трактованы как тип:
accountList
Не стоит, так же, использовать номера в имени переменной:
const a1, a2, a3
Использование синтаксического шума – плохая практика. Слова, которые означают одно и то же: Info или Data. Например:
ProductInfo, ProductData, NameString, CustomerObject
Хорошая практика – давать имена переменных хорошо звучащие на слух. Программирование есть социально активное занятие и произнося в слух непроизносимые слова можно запутать и себя и коллег:
private Date genymdhms; => private Date generationTimestamp;
Используйте имена переменных, которые легко найти в поиске. Это еще одна причина, почему не стоит давать односимвольные имена: скажем буква e, встречается чаще всего в английском языке. Давая переменной такое имя, найти ее по поиску практически невозможно. В целом хорошее правило: длинна имени переменной должна коррелировать с ее областью видимости.