Строка документации Python

Документация необходима для любого программирования, чтобы легко понять код. Он используется для объяснения цели использования любого оператора, функции, класса или модуля в программе. Это помогает основному кодеру запомнить функцию любого кода через долгое время, а также помогает другим кодировщикам, которые хотят работать над тем же проектом. Кодировщик использует одну строку комментария, чтобы вскоре объяснить конкретную часть функции кода. Строка документа Python или строка документации используется для подробного объяснения функции определенного сегмента кода. Строка документации должна начинаться с заглавной буквы и заканчиваться точкой. Первая строка строки документации содержит краткое описание документации в целом. Вторая строка строки документации должна быть пустой для большой многострочной строки документации. Тройные одинарные кавычки ('”) или же тройные двойные кавычки («» ») используются для определения строки документации в Python. Доступ к содержимому строки документации можно получить, используя __doc__ атрибут объекта и используя помощь() метод. В этом руководстве показан способ объявления и доступа к строке документации в Python.

Пример-1: Доступ к строке документации функции с помощью __doc__ атрибут

Способ объявления и доступа к строке документации пользовательской функции показан в следующем скрипте. Следующий скрипт вычисляет x^п где x и n будут взяты у пользователя. Мощность () функция определена в скрипте для выполнения задачи. Здесь для этой функции определена строка документации. __doc__ Атрибут был использован в скрипте для печати строки документации с выводом.

def мощность (x, n):
"Вычислите x в степени n
Считайте значения x и n из аргументов функции
и вычислить и вернуть значение x в степени n."
вернуть х ** п
# Принимаем значение x
x = int (input ('Введите значение x:'))
# Принимаем значение n
n = int (input ('Введите значение n:'))
# Распечатать возвращаемое значение функции
print ("% d в степени% d =% d"% (x, n, power (x, n)))
# Распечатать значение строки документации
print ("Содержание строки документации: \ n" + power.__doc__)

Выход:

Следующий вывод появится после выполнения вышеуказанного скрипта.

Пример-2: Доступ к строке документации класса и метода с помощью помощь() метод

Способ объявления и доступа к строке документации и методам этого класса показан в следующем скрипте. Основная функция скрипта - отсортировать числовой список и перевернуть данные списка. В классе был объявлен числовой список из 8 элементов, а строка документации была определена в начале класса с использованием тройных одинарных кавычек. В классе был определен метод sort_list () для печати отсортированных данных списка, и документ определил это для этого метода. reverse_list () Метод определен для печати перевернутых данных списка, и для этого метода также была определена строка документации. помощь() метод был вызван три раза в конце скрипта для печати строки документации list_operations класс, sort_list () метод, а reverse_list () метод.

класс list_operations:

класс list_operations:
"
Сортировка и обращение данных списка
Класс содержит два метода,
sort_list () будет отсортировать и распечатать список,
Метод sort_reverse () перевернет и распечатает список.
"
# Определить список числовых данных
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (сам):
"
Распечатать значения списка после сортировки
Функция возьмет объект списка числовых данных из аргумента,
отсортировать значения списка с помощью метода sort ()
и распечатать значения отсортированного списка.
"
# Сортировать список
себя.listdata.Сортировать()
# Распечатать отсортированный список с помощью цикла
print ("Значения отсортированного списка: \ n")
для ценности в себе.listdata:
print (значение, "", конец = ")
def reverse_list (сам):
"
Распечатайте значения списка после реверсирования
Функция возьмет объект списка числовых данных из аргумента,
перевернуть значения списка с помощью метода reverse ()
и распечатайте значения перевернутого списка.
"
# Перевернуть список
себя.listdata.обеспечить регресс()
# Распечатать перевернутый список с помощью цикла
print ("Значения отсортированного списка: \ n")
для ценности в себе.listdata:
print (значение, "", конец = ")
# Распечатать значение строки документации класса
помощь (список_операций)
# Создать объект класса
obj = список_операций ()
# Вывести значение строки документации для конкретного метода
помощь (obj.sort_list)
# Вызвать метод для печати отсортированного списка
объект.sort_list ()

Выход:

Следующий вывод появится после выполнения скрипта. Вся документация скрипта была напечатана впервые помощь() функция. Строка документации sort_list () метод напечатан второй помощь() функция.

Пример-3: Доступ к строке документации встроенного модуля Python

В предыдущих примерах строка документации использовалась в пользовательском классе и функции. Каждый встроенный модуль и класс Python имеет свою строку документации, которая объясняет цель использования этого конкретного модуля или функции. Кодировщик модуля или функции определяет строку документации, чтобы сделать код понятным для пользователей. Следующий скрипт распечатает предварительно определенную строку документации модуля datetime с помощью параметра помощь() функция.

# Импортировать модуль datetime
дата и время импорта
# Показать строку документации datetime
помощь (дата и время)

Выход:

После выполнения скрипта появится следующий вывод. Строка документации модуля datetime показывает подробную документацию по нему, чтобы помочь другим правильно узнать функции классов и методов, определенных в этом модуле.

Заключение:

Правильная документация важна, когда любой модуль или функция реализуется для конкретной цели, чтобы помочь другому кодеру использовать модуль в своем коде для выполнения конкретной задачи. Если документация не определена должным образом для модуля или функции, другие пользователи столкнутся с проблемами при ее использовании. Таким образом, каждый кодировщик должен использовать строку документации документа, чтобы предоставить остальным подробную информацию для понимания кода.