[프로그래밍] 주석과 가독성 by Kim Pope

주석에 대한 기존에 내 생각과 다르고 주석에 대한 고민을 해결해 줄 만한 이야기이다. 거의 혼자 코딩을 하다보니 가독성이 떨어지고 시간이 지나고 내가 봐도 이해하기 힘들만한 코드가 난무하고 있다. 거진 프로토타입에나 쓸법한 코드들이 난무하고 있는데… 우선은 잘 정리 할 수 있는 프로그래밍 패턴들에 대해서 잘 몰랐다.

주로 내가 작성한 코드들은 다음과 같은 현상들을 보였다.

1.코드의 재사용성이 매우 떨어졌다.

즉 비슷한 동작의 코드를 작성 할 때도 복사 붙여넣기 식의 코드를 많이 사용하게 되었다.

2.코드를 수정하다 보면 원치 않는 버그가 잔뜩 발생하는 경우가 많았다.

코드의 가독성이 떨어지게 되어 수정이 힘들어지고 한가지 동작을 하는 코드에 관여하는 변수나 잡다한 것들이 많아지면서 코드를 추가하거나 제거하면서 수정할 부분이 많아지고 그에 따른 실수들이 많아진다.

3.프로그래밍 패턴을 모르더라도 코드를 정리하는 습관이 점점 약해져갔다.

프로그래밍 패턴을 몰라도 나름 쓰기 쉽게 코드를 정리하고자 하는 편이었는데 지속적으로 혼자 작성하는 코드들을 만져가다 보니 코드 리팩토링등이나 코드 작성에 대한 고민을 적게하게 되어 갔다.

 

가장 큰 문제는 3번에 있지 않았을까 한다. 내 코드의 가독성이 떨어짐을 알면서도 개선을 하려는 의지가 없었던것. (사실 의지는 있었지만 귀찮았던… 뭐 행해지지 않은 일은 안한거랑 다를게 없지.)

 

위에 문제에 대해 김포프님의 생각은 오히려 주석을 이용하여 코드를 설명하는 것보다는 누가 읽어도(어느 정도 프로그래밍 지식이 있는 사람이야기 겠지) 간단하게 이게 어떤 동작을 위한 코드인지 쉽게 읽을 수 있도록 가독성 높은 코드를 짜는 것이 옳다 라는 입장인듯 하다.(인듯하다라고 쓴 것은 내가 동영상을 보고 그렇게 이해했다는 부분이다. 김포프님의 의도는 다를 수 있다.) 주석을 작성해야 하는 코드는 다른 사람들이 많이 사용하게 될 API에는 사용해야 한다라고도 이야기 한다. (API는 내부 소스가 공개되지 않는 경우가 많기 때문에 그런듯 하다.)

 

즉 코드 가독성 개선을 위해 지금 조금씩 공부하고 있는 프로그래밍 패턴의 중요성이 한층 더 올라갔다는 것!

Advertisements

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s