Автор оригинала: Robin Andrews.
Сегодня мы собираемся посмотреть два способа сделать ваш код Python очиститель.
Что это обозначает? Ну, код очень часто читать Люди, кроме человека, которые написали его, в целях обслуживания, интеграция в более крупные системы, отладки и т. Д. В школе, это может быть ваш учитель, который его читает. Также стоит помнить, что вы сами должны прочитать свой код, как вы его разрабатываете, и что, если вы вернетесь к своему собственному коду, после чего даже короткое время, вы также можете быть другим человеком с точки зрения понимания его (если вы сомневаетесь в этом Может, попробовать небольшой эксперимент …).
В Python есть Набор рекомендаций Для написания кода, который является EAY, чтобы прочитать и работать, независимо от того, кто написал его. Этот набор руководящих принципов называется Pep 8 Отказ Он содержит совет по тому, как:
- Соглашения об именах
- Макет кода
- Длина линии
- Отступ
- Использование комментариев
- Общие подходы на основе простота
Одной из основных ценностей, которые эти рекомендации предназначены для поддержки, является Читабельность Отказ
Хорошей идеей, чтобы начать включить некоторые рекомендации от Pep 8 как можно раньше в вашем обучении, чтобы установить хорошие привычки.
Онлайн Pep8 Checker
Один из способов сделать это – войти в привычку проверять ваш код против стандартов, используя какой-то инструмент. Есть много способов сделать это, но для коротких программ один из моих любимых способов – использовать Pep 8 онлайн Checker Отказ
Просто вставьте свой код и нажмите кнопку, чтобы увидеть список всех нарушений стандартов PEP 8, которые вы виновны. Вы можете быть удивлены тем, как «суеты» предложены, но делать то, что нужно для хранения Checker Happy – отличный способ разработки дисциплины, который вам нужно написать лучший код.
Pycharm Reformat Code.
В оформлении Предыдущая статья Я обсудил различные редакторы, которые вы можете использовать для программирования с Python. Один из был Pycharm Community Edition Отказ
Лично для небольших проектов я предпочитаю использовать более базовый текстовый редактор, затем Pycharm, такой как Notepad ++. Это потому, что я не всегда хочу создавать целую структуру проекта для простой программы, а также требуется некоторое время, чтобы начать. Однако, когда я близок к выполнению программы, я часто открываю Pycharm, чтобы использовать только один Невероятно полезная функция – Реформатский код вариант под Код меню. Один клик, и все ваши Маленькие программирования PeccaDilloes исчезнет на тонкий воздух. Такие вещи, такие как проблемы с интервалом, плохое использование пустых линий, проблемы вдавливания и т. Д. Все прошли. Вы можете настроить много вариантов для переформатирования, но я нахожу варианты по умолчанию, как правило, достаточно.
Некоторые могут утверждать, что вы должны стремиться избегать этих ошибок в первую очередь и я согласен. Однако они все еще случаются, по крайней мере для меня.
Используя Pycharm Реформатский код вариант в сочетании с Pep 8 онлайн Checker Упомянутые выше – отличный способ убедиться, что ваш код избегает некоторых более распространенных ошибок, которые программисты делают с точки зрения написания Чистый код Отказ Для меня это имеет смысл переформатировать вам код перед использованием Checker PEP 8. Для крупных проектов этот подход не очень жизнеспособны, но для небольших программ он обеспечивает отличный способ убедиться, что вы получаете разумно чистый код.
Конечно, чистый код включает гораздо больше, чем эти основные проблемы, но это отличное начало. Вы можете узнать больше о Clean Code здесь на SimpleProgrammer.com Отказ
Глупая консистенция – это хобгоблин из маленьких умов
Остерегайтесь, однако, что рабская преданность в абсолютных правилах редко является хорошей идеей. Упомянутый выше сайт Python.org напоминает нам об этом:
Тем не менее, знайте, когда быть непоследовательным – иногда рекомендации в стиле руководства просто не применимы. Когда сомневаетесь, используйте свое наилучшее решение. Посмотрите на другие примеры и решите, что выглядит лучше всего. И не стесняйтесь спрашивать!