Типичные улучшения

Для поиска по тегу начните название тега с символа '@'.

Улучшения, показаны 35 из 35.

Подберите точные названия

Когда код исполняет компьютер, ему не важны названия, можно хоть a,b,c,x,y использовать, он справится. Названия …

Замените транслит на англоязычные названия

Программный код - это текст на английском языке. Его читают подобно статьям и документации. Транслит …

Используйте в названиях правильный регистр букв

Верхний и нижний регистр букв в названиях имеют значение. По ним программист узнает тип сущности: …

Разрешите конфликт имен

В Python есть названия, занятые стандартными функциями и классами — `dict`, `list`, `range`. Python разрешает …

Избавьтесь от типов в названиях

Вся приятность системы типов в Питоне заключается в том, что мы не указываем типы. Благодаря …

Не путайте JSON и полученные оттуда данные

JSON — это текстовый формат данных, в Python он представляется в виде строки. Результат декодирования …

Начните название функции с глагола

Каждая функция — это действие, поэтому название должно содержать глагол. Еще лучше, если название начинается …

Уберите числа из названий

Когда какое-то значение не меняется, хочется записать его в имя. Например, если вам всегда надо …

Поправьте множественное число в названиях

Программист ориентируется в коде по названиям переменных. Если сначала вам встретится переменная `apples`, а в …

Используйте UPPER_CASE для переменных окружения

Так исторически сложилось, что переменные окружения принято называть в верхнем регистре с символом подчеркивания: не …

Избегайте глаголов в названиях переменных

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

Дайте токену специфичное название

Со временем в дополнение к одному API может понадобиться подключение еще нескольких. У них каждого …

Используйте общепринятые сокращения

Здорово, когда для переменной удается подобрать короткое и одновременно понятное название. Но если все же …

Не путайте порядок слов в названиях

Названия переменных редко укладываются в одно слово, порой важно уточнить, что речь не о каком-то …

Покажите чем отличаются переменные

Если в программе для отправки писем вы встретите переменные `letter_begin`, `letter_middle` и `letter_end`, то наверняка …

Укажите русскоязычный verbose_name

Атрибут `verbose_name` задает те названия, что получат поля модели данных при отображении в админке. Русскоязычный …

Запретите свалку в каталоге

Если название каталога позволяет класть в него всё что угодно, то довольно быстро папка превратится …

Учтите специфику window.getmaxyx

Метод `window.getmaxyx()`, несмотря на своё название, возвращает не координаты крайней ячейке, а ширину и высоту …

Уточните название функции

Названия функций важны. Хорошее название подсказывает программисту, что делает код функции и что он вернёт …

Укажите related_name во множественном числе

Если `related_name` указан в единственном числе, то запросы с его участием выглядят очень странно. Проблема …

Добавьте DB к названию переменной окружения

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

Высушите названия

Никто не хочет читать водянистый текст, в котором смысл прячется за пятиэтажными оборотами и десятками …

Уточните о каком пользователе речь

Ничто не встречается в моделях данных так же часто, как ссылка на юзера через `ForeignKey` …

Уточните название переменной

Названия переменных важны. Хорошее название подсказывает программисту, что лежит в переменной и какие методы можно …

Уточните название класса в HTML

Название классов так же важны, как и названия переменных, функций. Именно классы связывают html-теги со …

Переименуйте CSS классы в kebab-case

Как и в Python для CSS классов есть свои правила по наименованию. Придерживайтесь их, чтобы …

Не путайте файл и путь к нему

Работа с файлами неразрывно связана с путями, названиями файлов и их расширениями. Возьмёшься за одно …

Избавьтесь от my_...

Если эта переменная "ваша", то кто создавал остальные? :) Из-за этого префикса `my_` весь проект …

Уточните название файла

Названия файлов важны. Хорошее название подсказывает программисту, что лежит в файле и куда писать новый …

Высушите related_name

В Django код запросов к БД имеет свойство распухать до неприличных размеров. И чем длиннее …

Высушите название поля

В Django код запросов к БД имеет свойство распухать до неприличных размеров. И чем длиннее …

Уточните название класса

Названия переменных важны. Хорошее название подсказывает программисту, что лежит в переменной и какие методы можно …

Избавьтесь от data в названиях

Невероятно, но факт. Данные хранятся почти в каждой переменной любой программы написанной за последние полвека! …

deprecated
Подберите говорящие названия для переменных

В коде программист ориентируется по названиям. Если они не сообщают ему ничего полезного, то дела …

deprecated