Очевидное, но необходимое.
- Комментирование. Очень важно придать коду смысл и помочь читателю разобраться в конкретном фрагменте кода.
Любая функция, которая у вас есть, убедитесь, что у вас есть комментарии, подтверждающие ее. Я всегда комментировал в строке, используя # в Python. Но есть гораздо лучший способ сделать это - использовать тройные одинарные или двойные кавычки.
Итак, такой код -
Это выглядело бы так-
Если в ваших комментариях содержится много информации, обязательно используйте кавычки. В противном случае достаточно комментариев в одну строку.
Пусть ваши комментарии говорят с читателем, как рассказчик в фильме.
2. Имена переменных- Имена переменных должны быть как можно более информативными и в едином стиле.
Это соглашение об именах, которому я следую, однако я бы хотелось бы добавить еще одно важное соглашение - присвоение имени переменной, которая сообщает тип структуры данных, которую она представляет.
