⚡️ Документируем код

Документация упрощает жизнь разработчикам и помогает понять, что делает определённые функция, класс или модуль без необходимости читать код целиком.

Если вы используете модули, то её можно увидеть в IDE, наведя на класс, метод или саму библиотеку — чаще всего там уже присутствует документация.

Что бы сделать свой код более понятным, необходимо написать """Информация о том, что делает метод""" под определением объекта.

Также, вы можете получить информацию, используя атрибут __doc__.

#теория #документация