Стиль программирования, комментарии и документирование
Оформление кода
Основная ссылка: pep-0008 — рекомендации к оформлению кода.
Анализаторы кода:
Жёсткость pep-0008
Почему так делать не всегда надо
Комментарии
- Не «что» и «как», а «зачем» и «почему»
- Комментарии vs. код на Python (это не Си же)
- Комментарии vs. строки документации
Выковыривание комментариев с помощью inspect.getcomments()
Магические числа
Аннотирование
https://docs.python.org/3/whatsnew/3.6.html#whatsnew36-pep526
Документирование
Битва PEP-ов: pep-0256, pep-0258 — оба отвергнуты.
https://wiki.python.org/moin/DocumentationTools#Automatic_Python_API_documentation_generation_tools
- пример
![/!\](/moin_static197/modernized/img/alert.png "/!\")
Устарело?
MkDocs сайт-генератор
Д/З
Переработать имеющийся код проекта в соответствие с flake8
- создать настроечный файл, в котором изменить умолчания, если они не соответствуют дисциплине разработки