파이썬_return 하는 이유는?

Q. 그럼 반환은 왜 하는가? (단순히 print 출력만 할 수 있는데..)

 

독스트링(Doctrings)

: 기본적으로 작은 문서를 만드는 방법

함수와 기타 코드 블록으로 문서를 작성할 때 사용할 수 있다.

 

미래의 자신이나 다른 사용자가 이 함수를 사용하면서 어떤 내용을 알게 되면 좋을지 설명해준다.

예를 들어 여기서 """ """ 사이에 주석을 달아 알아보기 편하게 하는 것이다.

 

함수를 사용할 때

짠

하고 설명해 준다!!

 

이렇게 함수의 문서화를 시작하고 함수에 짧은 설명을 추가할 수 있고,

여러 줄로 된 주석을 쓸 수 있다.

원하는 만큼 주석을 달 수 있다. (# 사용하지 않아도!)

 

파이썬에서는 ctrl + / 하면 주석처리됨 

 

---

gpt가 기가막히게 설명해줘서 긁어왔다 ^^

 

 

파이썬에서 독스트링(Doctrings)은 함수나 모듈 등의 코드에 대한 설명을 작성하는 방법입니다. 독스트링은 주로 코드의 가독성과 유지보수성을 높이기 위해 사용됩니다.

 

return 함수는 함수가 실행된 결과를 반환하는 기능을 합니다. 이 때, 함수가 반환하는 값의 의미나 형식 등을 명확히 설명해 놓으면 사용자가 함수를 더 쉽게 이해하고 사용할 수 있습니다. 따라서 return 함수에 독스트링을 작성하는 것은 좋은 습관입니다.

예를 들어, 아래와 같은 코드가 있다고 가정해보겠습니다.

def add(a, b):
    """
    This function adds two numbers and returns the result.

    Parameters:
    a (int): The first number to be added.
    b (int): The second number to be added.

    Returns:
    int: The sum of a and b.
    """
    return a + b

 

 

위 코드에서는 add 함수가 두 개의 숫자를 더하고 그 결과를 반환한다는 것을 명시하고 있습니다. 또한, a와 b 매개변수가 각각 어떤 역할을 하는지, 반환되는 값의 형식이 무엇인지 등을 설명하고 있습니다. 이러한 독스트링을 작성해 놓으면 다른 개발자나 자신이 나중에 코드를 볼 때 함수의 역할과 사용법을 빠르게 파악할 수 있습니다.

 

>>> help(add)
Help on function add in module __main__:

add(a, b)
    This function adds two numbers and returns the result.

    Parameters:
    a (int): The first number to be added.
    b (int): The second number to be added.

    Returns:
    int: The sum of a and b.

 

또한, 독스트링은 help() 함수를 사용하여 함수에 대한 설명을 출력하는 데에도 사용됩니다. 예를 들어, 위의 코드에서 add 함수에 대해 help() 함수를 호출하면 아래와 같이 독스트링 내용이 출력됩니다.

따라서, 독스트링은 코드의 가독성을 높이고 유지보수를 용이하게 만드는 좋은 도구입니다.