Lections/Lesson11/2-string_docs/task_doc_1.py - main - IvanKhabarov/python

Lections/Lesson11/2-string_docs/task_doc_1.py

33 строки2 KB

Ivan-Khabarov

Добавлен урок 11

29 сен 2024, 13:44

29 сен 2024, 13:44833c32c

# Как и при создании функции, при создании классов принято оставлять
# документацию к нему. Для этого достаточно использовать многострочный
# комментарий сразу после определения класса — строки class ClassName:
# Посмотрите на пример

class User:
    """A User training class for demonstrating class
    documentation.
    Shows the operation of the help(cls) and the dander method
    __doc__"""

    def __init__(self, name: str):
        """Added the name parameter."""
        self.name = name

    def simple_method(self):
        """Example of a simple method."""
        self.name.capitalize()

u_1 = User('Спенглер')
print('Справка класса User ниже', '*' * 50)
help(User)
print('Справка экземпляра u_1 ниже', '*' * 50)
help(u_1)

# После заголовка класса оставили пару строк описания. Также добавлена строка
# документации для метода __init__. Далее вызываем справку для класс User и для
# его экземпляра. С первого взгляда они похожи и выводят куда больше информации.
# Помимо оставленной документации help собирает информацию о методах класса.
# Выводит первую строку метода и строку документации метода, если она задана
# многострочным комментарием.
# Отличие справки для класса и экземпляра лишь в первой строке. Сравните:
# Help on class User in module __main__: