Откройте секреты Python: Как создать идеальное описание функции и повысить читаемость вашего кода! Познайте мощь docstrings прямо сейчас!

Python: как сделать описание функции

В Python, описание функции обычно делается через так называемые docstrings. Docstring — это строка, которая идёт сразу после определения функции и используется для документирования функции.

Базовый пример

    
    def add(a, b):
        """
        Эта функция складывает два числа.

        :param a: первое число
        :param b: второе число
        :return: сумма a и b
        """
        return a + b
    
    

Доступ к docstring функции

Вы можете получить доступ к docstring функции, используя свойство __doc__ функции.

    
    print(add.__doc__)
    
    

Это выведет:

    
    Эта функция складывает два числа.

    :param a: первое число
    :param b: второе число
    :return: сумма a и b
    
    

Использование сторонних библиотек для автоматической генерации документации

Существуют также библиотеки, такие как Sphinx, которые могут автоматически генерировать документацию для вашего кода на основе ваших docstrings.