Мы знаем, что Python легко изучать, писать и читать. собственно, именно поэтому он отличается от других языков. Люди путаются со странным синтаксисом других языков, даже программиста, но не в случае Python. Причина, по которой большинство людей предпочитают Python из-за его простоты, а не из-за его производительности. Хе-хе! и мы должны оставаться простыми как есть. помните принцип KISS?
Почему Python лучше, потому что он удобочитаем!
Как разработчик, мы часто вносим изменения при написании кода, но если вы еще не написали хороший код! тогда, вероятно, вы застряли при изменении кода. на самом деле, даже если вы посещаете его через несколько дней, а затем не можете читать, потому что вы писали неэффективно, или, может быть, вашим коллегам приходится работать над вашим кодом, тогда что вы думаете? Как они это собираются?
Любой дурак может написать код, понятный компьютерам, но хорошие программисты пишут код, понятный людям!
Каждый разработчик жалуется на запрос на изменение, но вы пишете удобочитаемый код, а не компьютер, а разработчик не сделает этого! Код, который трудно читать, вызывает множество проблем, таких как жесткое преломление кода, который также трудно отлаживать и требует много времени. как разработчик, мы читаем код в 10 раз больше, чем пишем код!
Не будьте эгоистами, будьте хорошим членом команды и постарайтесь быть писателем, а не просто программистом!
Итак, вот несколько советов по форматированию, документации (комментариям) и соглашениям об именах!
Длина линии
Вот одно правило большого пальца: если вы набираете 79 * символов в строке, то, вероятно, вы делаете что-то не так.
Именование разговора [ИЗ ДОКУМЕНТОВ PEP8]
Используйте правила именования функций: строчные буквы со словами, разделенными подчеркиванием, по мере необходимости для улучшения читаемости.
Используйте одно подчеркивание в начале только для закрытых методов и переменных экземпляра.
Имена классов обычно должны использовать соглашение CapWords.
Имена переменных следуют тому же соглашению, что и имена функций.
Константы обычно определяются на уровне модуля и пишутся заглавными буквами с подчеркиванием, разделяющим слова.
Документация ( строки документации )
Напишите строки документации для всех общедоступных модулей, функций, классов и методов. Строки документации не нужны для закрытых методов, но у вас должен быть комментарий, описывающий, что делает метод. Этот комментарий должен появиться после строки def. Эти строки документации будут доступны через __doc__ и встроенную функцию python help ().
Полезные правила👍
- Часто оглядывайтесь на код!
- Используйте автоматическое форматирование IDE и после использования проверьте, какие изменения внесла IDE, и подумайте, почему. вот почему это важно!
- Изучите различные типы автоматического форматирования в IDE, узнайте, какой из них подходит вам и вашему проекту! в питоне есть PEP8, Black, yapf
- Совместное программирование или обмен мыслями с коллегой
- Пощадите своего командного игрока! 😉
- Прочтите это стихотворение и поймите его глубокий смысл [в слове стихотворения есть волшебство!]
- Запачкай руки!
- Вместо того, чтобы использовать регистратор для печати, таким образом будут удовлетворены оба требования.
Заключение, справка и до свидания!
Мой вывод прост: эти три вещи, форматирование, документирование (комментарии), соглашения об именах настолько просты, но очень важны.
Есть его оттенки, я привел кое-что из этого. Хотите узнать о стандартах PEP8, перейдите по ссылке «Ссылка» в поле ответа (комментария).
Поделитесь в твиттере, если вам понравилось❤️
Если вам понравилась эта статья, тогда хлопайте в ладоши👏…!
Увидимся позже, продолжай кодить и получай удовольствие ❤
Джамиль.
