8 8 8 8 8 8 8 8 8 8 8 8 8 8
8
8
|
|
Интермеццо: Стиль написания кода - Программирование от RIN.RU
Интермеццо: Стиль написания кода
Теперь, когда вам предстоит писать более объёмные и сложные блоки кода на Python, настало время поговорить о стиле написания кода (coding style). Код на большинстве языков программирования может быть записан (или, точнее говоря, отформатирован (formatted)) различными способами; некоторые из них более читабельны, некоторые - нет. Стремление к написанию лёгкого для прочтения другими кода всегда считалось хорошим тоном, и выбор правильного стиля для кода крайне ему способствует.
В случае языка Python, в качестве руководства по стилю было создано предложение PEP8, которого придерживаются создатели большинства проектов. В нём учреждается чрезвычайно читабельный и приятный для глаза стиль написания кода. В некоторый момент с ним должен ознакомиться каждый разработчик на Python.
Приведём здесь избранные, наиболее важные, пункты: - Используйте отступ в 4 пробела, не используйте табуляцию - 4 пробела легко опознаются и в случае небольших отступов (хватает места для глубоких вложений) и в случае больших - отступов (приятнее читается). Табуляция вносит путаницу и лучше от неё воздержаться. - Разделяйте строки так, чтобы их длина не превышала 79-и символов. Это поможет пользователям с небольшими экранами, а пользователям с большими экранами позволит уложить несколько файлов с исходным кодом рядом. - Используйте пустые строки для отделения функций, классов, и крупных блоков внутри функций. - При возможности располагайте комментарий на отдельной строке. - Используйте строки документации (док-строки) - Применяйте пробелы вокруг символов операций и после запятых, но не добавляйте их в конструкции со скобками: a = f(1, 2) + g(3, 4) - Называйте ваши классы и функции единообразно; соглашение следующее: используйте CamelCase для именования классов и нижний_регистр_с_подчёркиваниями для функций и методов. (обращайтесь к разделу Первый взгляд на классы за дополнительной информации о классах и методах) - Не используйте в вашем коде изощрённых кодировок, если он рассчитан на использование в интернациональной среде. Стандартный набор ASCII всегда работает на ура.
Назад Вперед
8 8 8
| |
|
|