코드 내 주석

5.1 주석 작성하는 방법

Python에서는 다른 많은 프로그래밍 언어들처럼 코드에 주석을 작성할 수 있어. 주석은 개발자나 다른 프로젝트 참가자들이 코드를 이해하는 데 도움을 줘서 협업이나 장기적인 유지 보수에 특히 유용하지. Python에는 코드에 주석을 추가하는 여러 방법이 있어.

단일 행 주석:

# 문자로 시작해. # 다음에 오는 모든 것은 같은 줄에서 Python이 무시해. 이 주석 타입은 일반적으로 특정 코드 라인에 대한 간단한 코멘트나 설명을 위해 사용돼. 예시:

# 이것은 단일 행 주석이야
print("Hello, World!") # 함수의 동작에 대한 설명

다중 행 주석:

Python에는 공식적으로 다중 행 주석을 위한 특별한 문법이 존재하지 않아, 하지만 여러 단일 행 주석을 사용하거나 삼중 따옴표를 사용할 수 있어. 삼중 따옴표는 사실 코드로 실행되지 않는 다중 행 문자열 리터럴이야. 예시:

# 이것은 다중 행 주석의 예시 # 각 줄은 # 기호로 시작해
      

또는:

""" 이것은 주석으로 사용할 수 있는 다중 행 리터럴이야. Python은 이것을 문자열로 해석하지만, 변수를 할당하거나 표현식에서 사용되지 않는 한 이 문자열을 아무것도 하지 않아. """ 
      

5.2 주석을 작성하는 이유

코드에 주석을 사용하면 가독성을 높이고, 유지 보수와 업데이트를 쉽게 하며, 팀 내에서 더 효율적인 협업을 도와. 주석은 간결하면서도 정보가 풍부하고 관련성 있어야 해서 코드의 유용한 문서화 역할을 해야 하고 불필요한 정보로 코드를 어지럽히지 않아야 해.

문서화 문자열 (docstrings):

모듈, 클래스, 메소드, 함수의 시작 부분에 주로 위치하여 그 목적을 설명하는 문자열이야. 삼중 따옴표로 감싸여 있으며, 자동 문서 생성에 사용될 수 있어.

예시:

def add(a, b):
""" 두 숫자를 더하는 함수야. :param a: 첫 번째 덧셈 :param b: 두 번째 덧셈 :return: a와 b의 합 """
    return a + b

프로그래밍 세계에서는 가끔 개발자들이 웃음을 자아내는 주석을 코드에 추가하곤 해. 여기 코드를 볼 때 웃음이 나는 몇 가지 예시가 있어:

예시 1

 

            # 무슨 일이 벌어지고 있는지 설명할 수 있지만, 나도 이제는 몰라.
        

예시 2

 

    # 이게 안 된다면, 다른 누군가의 잘못이야.

예시 3

 

    # 와서 봤고, 고쳤고... 망가졌어.

예시 4

 

    # 이걸 썼을 때, 나와 신만이 이게 어떻게 작동하는지 알았지. 
    # 이젠 신만 알아.

이런 주석들은 개발 과정에 가벼움과 유머를 더해 코드 베이스를 덜 단조롭게 만들어 줘. 또한 소프트웨어 개발이 창의적이고 인간적인 과정임을 상기시켜 줘.

5.3 빠르게 코드 주석 처리하기

PyCharm에서는 단축키를 사용하여 코드를 빠르게 주석 처리하거나 주석 해제할 수 있어. 변경하려는 코드 줄을 선택하고 Windows에서는 Ctrl + / (또는 macOS에서는 Cmd + /) 키를 누르면 돼. 이 키 조합은 선택된 각 줄에 주석 기호를 추가하거나 제거하여 과정을 빠르고 효율적으로 만들어 줘.