TGViewer
Python Community Python Community @python_community_ru · 11.6K subscribers
Post #889 3.99K
⚡️ Документируем код

Это — строка под определением объекта. Удобнее всего писать многострочную документацию. Она начинается с трёх кавычек и записывает всё, до следующих трёх кавычек.

Но этого знать недостаточно, поскольку у Python есть соглашение:

• Первая строка всегда должна быть кратким кратким описанием назначения объекта. Начинается с заглавной буквы, заканчивается точкой.

• Если в документации больше одной строки, вторая должна обязательно быть пустой.

• Следующие строки должны быть одним или несколькими абзацами, описывающими всё самое важное об объекте.

Ну а если вы хотите получить документацию из приложения, то возьмите его из __doc__.

#теория
More from @python_community_ru
  1. Oct 14, 2026📱 35 млрд параметров на смартфоне с потреблением около 3 ГБ оперативной памяти. OpenBMB п…
  2. Oct 12, 2026⚡️ Overmind - open-source слой для автоматической оптимизации AI-агентов. Вместо ручного т…
  3. Oct 12, 2026‍🖥 Python-дайджест недели: агенты с онтологией, рантайм-проверка типов и SQLite в проде С…
  4. Oct 10, 2026‍🐍 Ротация прокси в Python может обходиться без списка IP и `random.choice()` Если провай…
  5. Oct 9, 2026‍Вышел Python 3.15: ленивые импорты, frozendict, UTF-8 по умолчанию и JIT, который наконец…
  6. Oct 8, 2026🦙 Ollaya: запуск моделей принятия решений в стиле Ollama. Скачиваете модель, поднимаете л…
Threads Profile ViewerView any public Threads profile without an account.Open ThreadLook →Writing with AI? Make it sound human.Metric37 rewrites AI drafts so they read naturally. Free AI detector, 1,500 words free.Try Metric37 →