Различия между версиями 4 и 6 (по 2 версиям)
⇤ ← Версия 4 от 2019-04-11 16:37:28 →
Размер: 2592
Редактор: FrBrGeorge
Комментарий:
← Версия 6 от 2019-04-12 15:26:58 → ⇥
Размер: 2826
Редактор: FrBrGeorge
Комментарий:
Удаления помечены так. Добавления помечены так.
Строка 23: Строка 23:
Магические числа
Строка 25: Строка 26:
[[py3tut:ontrolflow.html#function-annotations]] [[py3tut:controlflow.html#function-annotations]]
Строка 47: Строка 48:
 * Переработать внутреннюю документацию в соответствие с выбранной системой документирования   * создать настроечный файл, в котором изменить умолчания, если они не соответствуют дисциплине разработки
## * Переработать внутреннюю документацию в соответствие с выбранной системой документирования

Стиль программирования, комментарии и документирование

Оформление кода

Основная ссылка: pep-0008 — рекомендации к оформлению кода.

Анализаторы кода:

Комментарии

  • Не «что» и «как», а «зачем» и «почему»
  • Комментарии vs. код на Python (это не Си же)
  • Комментарии vs. строки документации

  • Выковыривание комментариев с помощью inspect.getcomments()

Магические числа

Аннотирование

controlflow.html

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

Д/З

  • Переработать имеющийся код проекта в соответствие с flake8

    • создать настроечный файл, в котором изменить умолчания, если они не соответствуют дисциплине разработки

LecturesCMC/PythonDevelopment2019/08_StyleAndDocumenting (последним исправлял пользователь FrBrGeorge 2019-04-12 15:26:58)