Стиль программирования, комментарии и документирование
TODO
Оформление кода
Основная ссылка: pep-0008 — рекомендации к оформлению кода.
Анализаторы кода:
Статический анализ: pyflakes, …
PyLint
Жёсткость pep-0008
Пример: в коде PyGame-проекта
- Настройка:
pylint --generate-rcfile
- Отдельные параметры
- Пример настройки для vim
Почему так делать не всегда надо
Комментарии
- Не «что» и «как», а «зачем» и «почему»
- Комментарии vs. код на Python (это не Си же)
- Комментарии vs. строки документации
Выковыривание комментариев с помощью inspect.getcomments()
Документирование
Битва PEP-ов: pep-0256, pep-0258 — оба отвергнуты.