rstJkee
@rstJkee

Нужно ли документировать классы python?

Документируют ли тру питонисты классы и если да, то через docstring, по стандарту?
  • Вопрос задан
  • 79 просмотров
Решения вопроса 1
Tomio
@Tomio
backend developer (python, php)
Работая в команде у вас не будет возможности не документировать классы, а так же функции и модули. Потому что:
1. Ваш код просто не пройдёт проверку по flake8 и ваш пайплайн в системе контроля версий упадет на этапе синтаксического анализа кода.
2. Это просто уважение к коллегам, которые будут работать с вашим кодом. КОмментарии намного облегчат им жизнь, да и вы вспомните что делает тот или иной класс или функция, если вернетесь к ним через какое-то время.

Если же вы работаете один, то вы вольны поступать как вам удобно и угодно.
Ответ написан
Пригласить эксперта
Ответы на вопрос 1
@bacon
И да, и нет.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы