Ctrl →

LebedKun · Июль 4, 2013 21:08:46

Эти простые правила помогут вам легче понять написанный код вам и другим:

1. Давайте имена переменным и функциям интуитивно понятные.
Правильно:

length = 2
width = 6
area = length * width

Неправильно:

a = 2
b = 6
S = a * b

З.Ы. За исключением случаев, когда вы пишите программу для матановских задач. Но в данном примере расчёт площади используется скорее для геометрических и физических задач, которые ближе к практике.

2. Оставляйте побольше комментариев в коде. Делайте документацию к коду, к функциям, к параметрам функций, к их использованию и т.д. Также будет очень хорошо написать сначала программу на естественном языке, а потом составлять для каждого пункта программы небольшую подпрограмму, оставляя метки пунктов в виде комментариев.

3. Используйте побольше пробелов, особенно там, где много скобок и других операторов.
Правильно:

summ = 1 / (i * (length * width / 4 ) )

Неправильно:

summ=1/(i*(length*width/4))

4. Если имя функции или переменной состоит не из одного слова, то используйте псевдопробелы “_” (настоящий пробел используется для разделения элементов строки кода) или стиль CamelCase.
Правильно:

check_summ = 10
CheckData = check_summ * 2

Неправильно:

checksumm = 10
checkdata = checksumm * 2

Отредактировано LebedKun (Июль 4, 2013 21:14:12)

Singularity · Июль 4, 2013 21:15:46

Спасибо, кэп

Lexander · Июль 4, 2013 21:17:52

В нормальных редакторах цветовое кодирование давно заменило пробелы :D

LebedKun · Июль 4, 2013 21:22:43

Lexander, да, но читать “слипшуюся” кашу из символов от этого легче не становится.

Отредактировано LebedKun (Июль 4, 2013 21:24:43)

Singularity · Июль 4, 2013 22:03:50

LebedKun
да нормально оно читается. Сделай скрин интересно что у тебя за шрифты и т.д.
Кстати, при передачи параметров рекомендуют так писать

Lexander · Июль 4, 2013 22:04:28

Кто мешает использовать нормальный шрифт с достаточным межбуквенным расстоянием?

JOHN_16 · Июль 4, 2013 23:30:29

Singularity
да нормально оно читается

аналогично, наплытие пробелов никак не улучшает восприятие.

LebedKun
а к чему все это? вы про pep8 не слышали? Или книги не читаете? (их не мало, есть даже специфичные, например не помню Автора но называется “Ремесло программиста”).
Я к тому что типичная ситуация - опытные знают это и в 1000 раз больше, новички все равно пишут как попало, и лишь немногие, оч немногие те кто из “начинающих” (т.е. те кто реально занимается изучением,) быстро проходят эту стадию потомоу тчо она опять же достаточно освещена в книгах и тп.

_________________________________________________________________________________
полезный блог о python john16blog.blogspot.com

bismigalis · Июль 5, 2013 00:12:22

не надо самодеятельности

sudo apt-get install pep8
pep8 my_file.py

Singularity · Июль 5, 2013 00:17:01

32 кб

py.user.next · Июль 5, 2013 02:06:53

LebedKun
Правильно:
summ = 1 / (i * (length * width / 4 ) )

summ = 1 / (i * (length * width / 4))

Python-сообщество

Уведомления

#1 Июль 4, 2013 21:08:46

Рецепт хорошо читаемого кода

#2 Июль 4, 2013 21:15:46

Рецепт хорошо читаемого кода

#3 Июль 4, 2013 21:17:52

Рецепт хорошо читаемого кода

#4 Июль 4, 2013 21:22:43

Рецепт хорошо читаемого кода

#5 Июль 4, 2013 22:03:50

Рецепт хорошо читаемого кода

#6 Июль 4, 2013 22:04:28

Рецепт хорошо читаемого кода

#7 Июль 4, 2013 23:30:29

Рецепт хорошо читаемого кода

#8 Июль 5, 2013 00:12:22

Рецепт хорошо читаемого кода

#9 Июль 5, 2013 00:17:01

Рецепт хорошо читаемого кода

#10 Июль 5, 2013 02:06:53

Рецепт хорошо читаемого кода

Board footer