Какое-то время покодив, я понял, что большинство программ, встречающихся в сети написаны очень грязно. Да и сам я не так сильно заморачивался с этим делом.
Давайте разберёмся, что значит грязно?
Для начала такой пример из обычной жизни - вы написали ручкой на бумаге какой-то текст и другой человек его взял почитать. Ага, но не тут-то было! Почерк настолько корявый, что на своём родном языке ничего не понятно.
Выходит один и тот же текст может как легко читаться, так и вызывать затруднения в восприятии. И конечно легко и приятно будет читать написанное в чётком исполнении.
Вот и в языке Python есть свод правил хорошего тона, стилей написания, и называется он
Разберём на примере кода из этого топика.
Анализатор кода показал огромное количество предупреждений.
А теперь разберёмся, где можно посмотреть эти ошибки, и примеры неправильных записей кода.
Я пользовался разными программами для написания кода - Notepad++, SublimeText, Atom, Pycharm, IDLE, онлайн интерпретаторами. И в конечном счёте я остановился на таком замечательном инструменте как Pycharm. Я не сразу оценил его по достоинству, но теперь большинство всех своих программ делаю именно в нём.
В Pycharm также есть запуск кода пошагово, что помогает отследить как программа работает. Ещё имеется встроенный дебаггер, что делает отладку кода более простой и куча всего ещё. Но сегодня речь пойдёт о его другом достоинстве, а именно автоматической проверкой на лету чистоты кода.
Смотрим, что же пайчарму не понравилось?
Благо всё подробно описывается и исправить не составит труда. На этом кусочке кода видны следующие косяки:
1) Функция agi_at начинается сразу за предыдущей функцией и не имеет разрыва, что смешивает обе функции в общую кашу. PEP8 подсказывает, что перед функцией нужно оставлять 2 пустых линии.
2) Ещё в agi_at () перед скобками разрыв, а ведь скобки относятся к функции, поэтому отделять их неразумно.
3) Условные комментарии (идут после знака решётки), имеют 1 пробел, а нужно 2. Опять же, чтобы не так всё сливалось.
4) В 53-й строке нет пробелов после запятых.
5) В 54 строке Damage_contr написана с большой буквы, нужно с маленькой
Исправляем данные недочёты и получается чистый, легко читаемый код
Есть множество других ошибок, многие предупреждения повторяются. После успешного исправления всех предупреждений, мы увидим такое окошко
Когда постоянно пишешь в пейчарм, и исправляешь все косяки сразу, то потом автоматически начинаешь писать чисто, приучаясь к единому стилю.
Желаю всем кодерам, успешного написания своих программ, и конечно же в грамотно выполненном стиле.
До новых встреч в следующих статьях!
Давайте разберёмся, что значит грязно?
Для начала такой пример из обычной жизни - вы написали ручкой на бумаге какой-то текст и другой человек его взял почитать. Ага, но не тут-то было! Почерк настолько корявый, что на своём родном языке ничего не понятно.
Выходит один и тот же текст может как легко читаться, так и вызывать затруднения в восприятии. И конечно легко и приятно будет читать написанное в чётком исполнении.
Вот и в языке Python есть свод правил хорошего тона, стилей написания, и называется он
Ссылка скрыта от гостей
Разберём на примере кода из этого топика.
Анализатор кода показал огромное количество предупреждений.
А теперь разберёмся, где можно посмотреть эти ошибки, и примеры неправильных записей кода.
Я пользовался разными программами для написания кода - Notepad++, SublimeText, Atom, Pycharm, IDLE, онлайн интерпретаторами. И в конечном счёте я остановился на таком замечательном инструменте как Pycharm. Я не сразу оценил его по достоинству, но теперь большинство всех своих программ делаю именно в нём.
В Pycharm также есть запуск кода пошагово, что помогает отследить как программа работает. Ещё имеется встроенный дебаггер, что делает отладку кода более простой и куча всего ещё. Но сегодня речь пойдёт о его другом достоинстве, а именно автоматической проверкой на лету чистоты кода.
Смотрим, что же пайчарму не понравилось?
Благо всё подробно описывается и исправить не составит труда. На этом кусочке кода видны следующие косяки:
1) Функция agi_at начинается сразу за предыдущей функцией и не имеет разрыва, что смешивает обе функции в общую кашу. PEP8 подсказывает, что перед функцией нужно оставлять 2 пустых линии.
2) Ещё в agi_at () перед скобками разрыв, а ведь скобки относятся к функции, поэтому отделять их неразумно.
3) Условные комментарии (идут после знака решётки), имеют 1 пробел, а нужно 2. Опять же, чтобы не так всё сливалось.
4) В 53-й строке нет пробелов после запятых.
5) В 54 строке Damage_contr написана с большой буквы, нужно с маленькой
Исправляем данные недочёты и получается чистый, легко читаемый код
Есть множество других ошибок, многие предупреждения повторяются. После успешного исправления всех предупреждений, мы увидим такое окошко
Когда постоянно пишешь в пейчарм, и исправляешь все косяки сразу, то потом автоматически начинаешь писать чисто, приучаясь к единому стилю.
Желаю всем кодерам, успешного написания своих программ, и конечно же в грамотно выполненном стиле.
До новых встреч в следующих статьях!
