5 обязательных правил написания строк документа в Python

Вы тоже поклонник дзен Python? Я знаю, что я! Вы можете найти его с помощью простого оператора import this. Насколько я понимаю, один из ключевых посылов этого стихотворения заключается в том, что ваш код должен «иметь смысл». Это должно быть «самодокументирование».

Эта статья немного объяснит иллюзорное обещание самодокументирующегося кода и предоставит список правил, которые вы должны знать о написании строк документации для своих функций.

В самом конце я предлагаю качественный пример функции, которая находит объем на основе трех входных данных и включает полную строку документации.

>>> import this

The Zen of Python, by Tim Peters

Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!

Самодокументирующийся код (несбыточная мечта)

«Самодокументирующийся код» — это фраза, которую часто используют в сообществе программистов. Концепция проста: пишите свой код так, чтобы он объяснял сам себя.

  • Хотя это практика, которой должен следовать каждый разработчик, бывают случаи, когда она не работает. ☹️ 😕 🙁 😟
  • Здесь на помощь приходят строки документации! 😀 😁 🙂 😄

Строки документации или строки документации — это, по сути, комментарии, которые описывают, что делает ваш код (модуль, функция, класс или метод). Одна из многих фантастических волшебных особенностей строк документации заключается в том, как встроенная функция Python help() может ссылаться на них. Функция help() обеспечивает простое в использовании встроенное справочное руководство по вашему коду.