Запрещенные слова для комментариев и имен

Мы договорились в команде, что слова new, now и old являются запрещенными для употребления в комментариях, именах переменных окружения, описаниях коммитов, когда речь идет об изменении поведения чего-либо.

Например, переменная окружения, включающая “старый” алгоритм генерации ключа: вместо OLD_KEY_ALGORITHM должно быть USE_ABCDEF_ALGORITHM.

Вместо ссылок на прошлое или будущее надо описывать конкретное поведение, так как характеристики new, now and old становятся неактуальными уже через неделю. А еще хуже, что они приводят к появлению таких имен как OLD_2_KEY_ALGORITHM или NEW_2_KEY_ALGORITHM.


Оригинальный пост | Disclaimer

Комментарии