파이썬의 주석

파이썬의 첫 강의는 주석입니다. 주석이란 무엇일까요? 위키백과의 정의를 살펴보도록 하겠습니다.

주석 또는 코멘트(comment)는 프로그래밍에 있어 내용을 메모하는 목적으로 쓰인다.

소스코드를 더 쉽게 이해할 수 있게 만드는 것이 주목적이며, 컴파일러와 인터프리터에 의해 일반적으로 무시되어 프로그램에 영향을 주지 않는다.

간단히 말하면, 컴퓨터를 위한 글이 아니라 코드를 읽는 사람을 위해서 쓰는 글이라는 뜻입니다. 파이썬에서는 주석을 어떻게 표현할까요?

# 한 줄 주석

#을 적고 그 뒤에 문장을 쓰면 주석으로 처리됩니다. 주석이 여러 줄 필요할 땐 한 줄 주석을 여러 개 작성하면 됩니다. 소스코드를 살펴볼까요?

# 여러 줄 주석
# 여러 줄 주석
# 여러 줄 주석
# 여러 줄 주석

주석으로 처리하는 방법은 아주 쉽습니다. #(샵)만 기억하면 되기 때문이죠. 중요한 것은 무슨 내용을 주석으로 하면 될까를 고민하는 것이라고 생각합니다. 

과연 어떤 내용들이 주석으로 와야 할까요?

---

사실 어떤 내용들도 다 주석이 될 수 있습니다. 하지만 불필요한 내용을 담을 필요는 없겠죠. 예를 들어서 설명해볼까요?

u = "20160311"

u는 변수입니다. 20160311이라는 값이 담겨 있습니다. 이 코드가 무엇을 뜻하는 지 바로 알기가 쉽지 않죠? 그렇다면 이해를 돕기 위해 주석으로 설명을 해줘야 한다고 생각할 수도 있습니다. 

# u는 user의 id를 나타냄
u = "20160311"

u가 user의 id를 나타낸다고 주석에 설명해주었습니다. 이제 코드에 대해서 이해하기는 쉽겠지만 사실은 변수명이 잘 못되었기 때문에 불필요한 주석을 쓰게된 것입니다. 변수명이 user_id가 되면 주석이 필요없이 바로 이해할 수 있게되죠. 이처럼 모든 것이 다 주석이 될 수는 있지만 불필요한 내용을 담지 않도록 고민해야하는 것이 주석입니다. 과연 어떤 내용들이 좋을까요 ?

기본적으로는 코드를 보는 사람들의 이해를 빨리 시켜주는 주석은 다 좋습니다. 하지만 위의 경우 처럼 주석을 넣지 않고도 충분히 설명할 수 있는 방법이 있는지 생각해보셔야 합니다. 

그런 의미에서 변수명을 생각하는 것은 아주 중요합니다. 너무 짧아도 좋은 것이 아니고, 길다고 해서 좋은 것이 아닙니다. 변수명에 값을 설명할 만한 충분한 것들이 들어있는지 생각하셔야 합니다. 불필요한 주석을 줄일수 있게 말이죠.

그리고 수정해야할 부분들이 있다면 주석의 내용으로 아주 어울립니다. 그럴땐 보통 어떤 주석들을 쓰는지 알아보겠습니다.

# TODO 

# 아직 하지 않은 일을 나타냅니다.

# FIXME 

# 오작동을 일으킨다고 알려진 코드니 수정이 필요합니다.

# HACK 

# 아름답지 않은 해결책을 나타냅니다.

# XXX

# 위험! 여기 큰문제가 있다는 것을 알려줍니다. 

주석은 코드를 읽는 사람들에게 좋은 나침반이 될 수 있도록 작성되어야 합니다. 짧은 코드가 좋은 것이 아니라 이해하는데 짧은 시간이 드는 코드가 좋은 코드라는 것을 기억해주세요!

주석에 어떤 내용이 오면 좋은 지에 대한 설명은 "읽기 좋은 코드가 좋은 코드다"라는 책을 참고하여 작성하였습니다. 

공감은 제작자에게 큰 힘이 됩니다.