[Python] 파이썬 주석 사용법 (한 줄, 여러 줄)

💻 주석의 역할

• 자신 또는 다른 사람을 위한 코드의 의도나 동작 방식을 설명하는 데 사용됩니다.
• 코드의 특정 부분에 대한 설명, 작업의 목적, 변경 이력 등을 주석으로 기록할 수 있습니다. 
• 코드를 이해하고 유지보수하는 데 도움이 됩니다.

---

💻 파이썬 주석의 종류

1. 한 줄 주석(Inline Comment)

• ' # ' 기호로 시작하며, 코드 한 줄에 설명을 추가할 때 주로 사용합니다.

x = 10  # 변수 x에 값 10을 할당합니다.

 

2. 블록 주석(Block Comment)

• ' ''' ' 또는 ' """ ' 기호를 사용하며, 여러 줄에 걸쳐 설명을 추가할 때 주로 사용합니다.

"""
이 부분은
여러 줄에 걸친
주석입니다.
"""

def greet(name):
    """
    주어진 이름에 인사하는 함수입니다.
    :param name: 인사할 이름
    :return: 인사말
    """
    return f"Hello, {name}!"

---

💻 파이썬 주석 사용시 주의사항

• 일관성 유지 : 주석의 일관성을 유지하여 코드의 가독성을 높입니다.
• 명확한 의도 : 코드의 의도나 동작 방식을 명확하게 작성해야합니다.
• 업데이트 유지 : 코드를 변경할 때 주석도 함께 업데이트 하여 일관성을 유지해야 합니다.
• 과도한 주석 지양 : 주석을 너무 많이 추가할 경우 가독성이 떨어질 수 있습니다.