И так пора рассказать о комментариях кода или как правильно говорить документирование кода. Строки документации - строковые литералы, которые являются первым оператором в модуле, функции, классе или определении метода. Такая строка документации становится специальным атрибутом __doc__ этого объекта.
Существует 2 основных способа:
1. Через решетку # 2. Через три двойных кавычки.
Первый способ используется для маленьких комментариев, второй я могу назвать подробным описанием
И так пора рассказать о комментариях кода или как правильно говорить документирование кода.
Строки документации - строковые литералы, которые являются первым оператором в модуле, функции, классе или определении метода. Такая строка документации становится специальным атрибутом __doc__ этого объекта.
Существует 2 основных способа:
1. Через решетку #
2. Через три двойных кавычки.
Первый способ используется для маленьких комментариев, второй я могу назвать подробным описанием
- Однострочники предназначены для действительно очевидных случаев. Они должны умещаться на одной строке.
- Многострочные строки документации состоят из однострочной строки документации с последующей пустой строкой, а затем более подробным описанием.