처음 프로그래밍을 배울 때는 내가 쓴 코드를 다른 사람이 읽을 일이 없기 때문에
주석의 중요성을 알기 어렵습니다!
그러나 실제 현업에서 개발을 하거나, 데이터 분석을 할때는 작성해야 할 코드의
양이 많이 많은 동료들과 업무를 나누어서 할 때가 많은데, 이 때 코드의 가독성과
이해를 높힐 수 있도록 “주석”을 사용합니다.
주석은 코드의 실행과는 상관없이 코드에 추가해 놓은 메모(Comment) 정도로
이해하면 좋은데요, 코드 공유, 유지보수, 업데이트에 중요한 역할을 합니다.
이 글에서는 개발자들의 비밀 암호 파이썬 주석에 대한 알아보도록 하겠습니다.
1. 주석의 역할과 중요성
주석은 단순히 코드를 설명하는 것 이상의 역할을 합니다. 코드를 작성할 때는 스스로의 생각과 논리가 명확하지만, 시간이 흐르고 다른 사람이 코드를 읽을 때는 그렇지 않을 수 있습니다. (가끔은 내가 쓴 코드도 이해하기 어려울 때가 많죠.)
이때 주석은 코드의 의도와 동작을 해설해주어 다른 개발자가 코드를 더 쉽게 이해할 수 있도록 도와줍니다. 주석을 통해 코드의 복잡성을 해소하고, 코드가 하는 일에 대한 명확한 설명을 제공할 수 있습니다.
요새는 개발자의 이직이 많기 때문에 처음 작성 할 때부터 누구나 이해하기 쉬도록 적절한 주석을 포함하여 작성하는 것이 더욱 중요해지는 추세입니다.
2. 주석의 종류와 사용 방법
주석은 크게 두 가지 형태로 작성됩니다.
1) 한 줄 주석
한 줄 주석은 # 기호로 시작하며, 해당 줄에서 # 다음에 오는 모든 내용은 주석으로 처리됩니다. 한 줄 주석은 해당 코드 뒤에 설명을 붙일 때 유용합니다.
result = x + y # 변수 x와 y를 더한 값을 저장2) 여러 줄 주석
여러 줄 주석은 ''' 또는 """ 사이에 내용을 작성하여 주석을 만듭니다. 이는 여러 줄에 걸친 주석을 작성할 때 유용합니다. 여러 줄 주석은 함수나 클래스를 설명할 때 자주 사용됩니다.
'''
이 부분은 함수의 설명입니다.
두 값을 더한 값을 반환 합니다.
'''
def add(a, b):
return a + b3. 주석의 활용 예시
1) 코드 설명
주석을 사용하여 코드의 목적이나 동작 방식을 설명할 수 있습니다. 이렇게 하면 다른 사람이나 나중에 본인이 코드를 이해하기 쉬워집니다.
# 두 수를 더하는 함수
def add(a, b):
return a + b2) 중요한 정보 제공
주석을 사용하여 특정 부분이나 중요한 정보를 강조할 수 있습니다. 다른 개발자들에게 특정 부분을 주목하게 할 수 있습니다.
def add(a, b): # 주의: 이 부분은 성능
return a + b3) 임시 코드 처리
주석의 가장 빈번히 쓰는 목적은 바로 TODO: 를 남기는 것입니다. 주석을 사용하여 임시로 코드를 비활성화하거나 특정 부분을 테스트하는 용도로 활용할 수 있습니다. 나중에 수정이 필요한 부분을 표시하거나, 특정 조건에서만 실행되도록 할 때 유용합니다.
def add(a, b): # TODO: 나중에 수정해야 할 부분
return a + b4. 주의사항과 권장사항
주석을 작성 할 때에는 아래의 두가지를 고려하고, 사전에 동료들과
어떤 방식으로 작성을 할지에 대해 함께 Rule을 정하는 것이 중요합니다.
1) 주석은 도움이 되어야 합니다
주석을 작성할 때는 코드의 이해를 돕거나 설명하는 역할을 해야 합니다. 불필요한 주석이나 모호한 주석은 코드를 혼란스럽게 만들 수 있습니다. 주석을 작성하기 전에 주석이 어떤 도움을 줄 수 있는지 고민해야 합니다.
2) 코드의 변경과 주석의 업데이트
주석은 코드와 함께 유지보수되어야 합니다. 코드가 변경될 때마다 주석도 함께 업데이트되어야 합니다. 주석이 오래되어 코드와 일치하지 않는 경우 혼동을 줄 수 있습니다. 코드를 수정할 때 해당 코드와 관련된 주석도 함께 업데이트하는 습관을 가져야 합니다.
주석은 프로그래밍에서 중요한 도구로, 코드의 가독성과 이해를 높이는 데 큰 역할을 합니다. 잘 활용하면 다른사람이 코드를 이해하기 편하고, 유지보수하기 쉽게 만들어 줍니다.
개발 못지않게 중요한 개발자의 비밀암호인 주석! 잘 활용해 보시기 바랍니다.
감사합니다. “끝”
