Differences between revisions 5 and 6
Revision 5 as of 2019-04-11 16:14:05
Size: 2593
Editor: FrBrGeorge
Comment:
Revision 6 as of 2019-04-12 12:26:58
Size: 2826
Editor: FrBrGeorge
Comment:
Deletions are marked like this. Additions are marked like this.
Line 23: Line 23:
Магические числа
Line 47: Line 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 (last edited 2019-04-12 12:26:58 by FrBrGeorge)