Python 독스트링(Docstring) 사용법

파이썬에서 독스트링(닥스트링)을 사용하는 간단한 예제 코드입니다.

2023.12.14 최초작성

 

독스트링(Docstring)은 Python에서 함수, 클래스, 모듈 또는 메서드에 대한 설명을 작성하는 데 사용되는 문자열입니다.  Python Enhancement Proposal 257(PEP 257)에서 독스트링을 작성할 때 따라야 하는 권장 사항을 제공합니다. Python의 인터랙티브 쉘에서는 help 함수를 사용하여 객체의 독스트링을 조회할 수 있습니다. 

닥스트링을 추가해놓으면 Visual Studio Code에서 함수 사용하려고 아규먼트 입력시 아규먼트에 대한 설명이 보입니다. 

또한 함수 파라미터에 마우스 커서를 가져가도 설명이 보이며  

함수에 커서 가져가도 독스트링에 적은 내용이 보입니다.  

자주 사용해야겠다 싶습니다.

독스트링은 """로 시작하고 끝나며, 함수의 첫 부분에 위치합니다. 찾아본 봐로는 다음 2가지 방식으로 독스트링이 작성가능합니다. 방식은 다르지만 함수의 파라미터와 리턴값을 설명합니다. 

 

def sum_and_multiply(a, b):     """     두 정수의 합과 곱을 계산합니다.     Args:         a (int): 첫 번째 정수.         b (int): 두 번째 정수.     Returns:         int: 두 정수의 합.         int: 두 정수의 곱.     """     sum_result = a + b     multiply_result = a * b         return sum_result, multiply_result result_sum, result_multiply = sum_and_multiply(3, 4) print(f"Sum: {result_sum}, Multiply: {result_multiply}")

def sum_and_multiply(a, b):     """     두 정수의 합과 곱을 계산합니다.     :param a: (int) 첫 번째 정수.     :param b: (int) 두 번째 정수.     :return: (int, int) 두 정수의 합과 곱으로 구성된 튜플.             첫 번째 요소는 두 정수의 합, 두 번째 요소는 두 정수의 곱입니다.     """     sum_result = a + b     multiply_result = a * b         return sum_result, multiply_result result_sum, result_multiply = sum_and_multiply(3, 4) print(f"Sum: {result_sum}, Multiply: {result_multiply}")

독스트링에 사용 예제를 추가하여 간단한 테스트를 해볼 수 있는 방법도 있습니다. 

 

Python 독테스트(Doctest) - 간단한 테스트 자동화

https://webnautes.tistory.com/2246