파이썬으로 프로그래밍 시작하기 - #코멘트란 무엇일까?

파이썬으로 프로그래밍일 배우기 앞서 파이썬을 포함한 거의 모든 프로그래밍 언어에 사용 될 코멘트에 대해서 알아보자.

 

파이썬으로 프로그래밍 시작하기 - #코멘트란 무엇일까?

Pixabay님의 사진: https://www.pexels.com/ko-kr/photo/265631/

우리말로는 주석이라고 하는 코멘트는 코딩을 하는 중 메모하거나, 코드를 설명하거나, 미완성된 부분을 표시하거나, 다른 개발자와 소통하기 위해서 코드의 중간에 써놓는 것이다.

줄의 앞에 "#"을 달아서 표기하고, #을 붙이면 이 라인은 컴퓨터가 해석하지 않는다.

print("#코멘트란 무엇일까?")
# 라인의 앞에 "#"을 붙여 놓으면 컴퓨터가 해석하지 않는다.
print("코멘트는 다양한 용도로 사용된다")

위와 같이 코드 중간에 삽입한 코멘트는 실행에 아무런 영향을 주지 않은 것을 알 수 있다.

 

코멘트는 언제 사용할까?

1. 코드 사이에 메모를 삽입하기 위해 사용한다
   나중에 다시 확인해봐야 할 내용, 점검해봐야 할 것 등을 코드 중간에 코멘트로 삽입하면 효율적이다.
2. 복잡한 코드를 설명하기 위해 사용한다.
   코드의 내용이 많아질수록 작성한 본인도 코드가 헷갈릴 수 있다. 코드 중간에 코드에 대한 설명을 삽입해 놓으면 본인 뿐만 아니라 협업하는 다른 개발자도 쉽게 코드의 내용을 이해할 수 있다.
3. 미완성된 부분을 표시하기 위해 사용한다.
   완성되지 않은 코드를 그냥 놔두면 작성자도 어디까지 작성이 되었는지 헷갈릴 수 있다. 또한 미완성된 코드에서 에러가 발생하지 않으면 더욱 헤매일 수 있다. 미완성된 부분에 코멘트를 달아놓으면 추후에 쉽게 찾고 수정할 수 있다. 또한 어디까지 작성되었는지 알기 쉽다.
4. 다른 개발자들과 소통하기 위해 사용한다.
   개발의 난이도와 범위가 커지면서 혼자 개발하기보다는 다른 개발자들과 분업/협업 하는 경우가 많다. 이 때 코멘트를 써놓으면 작성된 코드에 대해서 서로 이해하고 소통하기에 좋다.

 

아직 초보자로서 배우는 과정에서 몇 줄 안되는 코드를 작성하기 때문에 아직은 코멘트가 중요하지 않을 수 있다. 하지만 점차 코드의 양이 많아지고 어려워지는 과정에서 코멘트를 중간중간 기입하는 것을 습관화 하는게 좋겠다.