Як викликати документацію Python?
Витягувати рядки документації можна двома способами:
- Через вбудований для кожного об'єкта атрибут-змінну __doc__.
- За допомогою вбудованої в Python функції help(), яка запускає інтерактивну довідкову систему.
Збережена копія
Як створити документацію для коду?
Загальні поради документування
- Обов'язково документуйте те, що здається вам нетривіальним.
- Наведіть приклад використання вашого коду …
- Якщо рішення нетривіальне, розкажіть про причини такого рішення.
- Постарайтеся знайти середину між відсутністю документації та документуванням кожного рядка …
- Не переказуйте код