Многие умные книжки по программированию говорят, что переменные надо называть наиболее понятно и осмысленно. Некоторые даже рекомендуют использовать Венгерскую нотацию (https://ru.wikipedia.org/wiki/Венгерская_нотация), различные стандарты и соглашения по именованию и другие интересные вещи. На самом деле все это излишне и даже вредно для опытного программиста.
Судите сами. Во-первых, содержательное именование переменных требует много времени, которое можно с большей пользой потратить на чтение новостной ленты. Во-вторых, если название переменной слишком длинное, вы можете устать его писать. И главное: если назвать переменную осмысленно, например, newsCount или news_count, то любой человек сможет догадаться о том, что она содержит. А значит, он сможет прочитать, понять ваш код и найти в нем проблемные места, что может негативно сказаться на вашей самооценке. Возможно, он сможет даже переписать код лучше вас! А значит вы больше не незаменимый сотрудник и находитесь в шаге от увольнения!
Такого допустить нельзя.
Опытный программист для именования переменных использует продвинутые технические средства, такие как генератор паролей. Это один из лучших способов повысить разработчикозащищенность - назовите переменную a378 и присвойте необходимое значение, тогда никто не будет менять это место вашего кода.
Помимо технических средств улучшения кода, есть еще и семантические. Не называйте переменную a, b или c, гораздо лучше подходит имя ugadai_cto. Переменную с таким именем можно естественно использовать несколько раз. Так вы без труда проведете оптимизацию кода, а вашей программе будет требоваться меньше памяти.
По возможности старайтесь использовать специальные символы из числа поддерживаемых вашим языком программирования. Переменные вида _, _l, _1, $_$ являются начальным шагом по пути к написанию само-обфусцируемого кода.
Если по каким-то причинам вам пришлось дать переменной содержательное имя, придерживайтесь следующих правил:
- Используйте наиболее короткое из возможных имен. Вместо newsCount и news_count лучше подойдет news. Компилятору имя все равно не важно, а остальным незачем знать, что здесь хранится - количество новостей, их список или одна новость.
- Если вам нужно несколько похожих имен, лучше всего используйте цифры. list1, list2 и list3 - идеальные имена для списков, соответствующие всем стандартам разработчикозащищенности.
- Если использование цифр не позволяет обеспечить должный уровень защиты, попробуйте схожие имена. dataList и datelist - вот подход настоящего профессионала, ценящего читаемость кода компилятором.
- Давайте переменным, классам и функциям наиболее общие имена - data, getArray, Object. Чем ближе эти названия к стандартным, тем лучше: желательно, чтобы пользователь вместо стандартных средств использовал ваши. Неизвестно, кто и как писал все эти библиотеки, ваша реализация должна быть лучше.
- Если стандартных имен недостаточно, используйте собственные правила кодирования и аббревиатуры.
Также вы можете воспользоваться наработками признанных мастеров на С - https://www.ioccc.org/
Используя эти простые правила и другие наши рекомендации вы обязательно научитесь писать идеальный код и приобретете славу среди своих коллег.
#Useful_programmers_tips by Gregory Oster