Блог компании Os_Engine | Нейминг объектов. Стандарты кода #2. Коннекторы к OsEngine #21

Именование переменных нормальным языком – важнейший признак уважения к другим программистам. А первый признак неуважения одного программиста к другому – запутанные названия переменных.

Можно было бы просто сказать, следи за тем, что пишешь. Пожалуйста обращай внимание на переменные. Но это не наш метод)

Мы пойдём от обратного. Поговорим про один из самых распространённых способов защитить код от использования конкурентами, наиболее часто используемый в среде разработки ПО. Об обфускации. А затем обсудим то, как делать не нужно.

Обфускация кода.

Процесс запутывания названия переменных и методов с целью недопущения использования этого кода другими программистами.

На данный момент существуют сотни программ, помогающих с этим самым запутыванием. И обфускация безусловно атомное оружие в руках противоборствующих команд разработчиков.

Если Вы хотите, чтобы код был нечитаемый и не был никем переиспользован, Вы должны дать вашим методам, переменным, событиям, etc… нечитаемые названия.

И наоборот.

Если Вы хотите, чтобы код был переиспользован другими программистами с радостью, первое с чего надо начать, это хорошие названия для ваших методов, переменных, событий и прочего. Без этого самолёт не взлетит. А другой код нам в OsEngine не нужен.

Далее. Подворовав немного картинок с хабра вот из этой статьи: https://habr.com/ru/companies/dododev/articles/714512/

Ещё поговорим о том, как не надо…

Название переменной ничего не говорит о её применении.

Избыточные названия.

Названия без контекста.

Неправильный перевод.

Калька с русского.

Итого, по важности, правильный нейминг это:

1. Уважение к товарищам программистам в первую очередь.
2. Важнейшее и основополагающее свойство хорошего кода во время работы над ним многими людьми, ибо неправильный нейминг, это атака на товарищей и страшное преступление!

Итого, по пунктам:

1. Название переменной должно говорить о её применении.
2. Название переменной не должно быть избыточным и вырванным из контекста.
3. Название переменной не должно быть транслитом русского в инглиш, и Вы должны хоть немного понимать о чём пишете.

Что почитать?

1. MSDN. Правила именования: https://learn.microsoft.com/ru-ru/dotnet/standard/design-guidelines/naming-guidelines?redirectedfrom=MSDN
2. https://youtu.be/wLA9rtbFiII Коротко по теме и с картинками! То, что нужно!

Пост из серии «Коннекторы к OsEngine»

Серия о том, как стать настоящим программистом и изменить свою профессию.

Оглавление и смыслы здесь: https://smart-lab.ru/company/os_engine/blog/959953.php

Комментарии открыты для друзей, добавляйтесь!

OsEngine: https://github.com/AlexWan/OsEngine
FAQ: https://o-s-a.net/os-engine-faq
Поддержка OsEngine: https://t.me/osengine_official_support

Регистрируйся в АЛОР и получай бонусы: https://www.alorbroker.ru/open
Сайт АЛОР БРОКЕР: https://www.alorbroker.ru
Раздел «Для клиентов»: https://www.alorbroker.ru/openinfo/for-clients