본문 바로가기
IT 공부/공부하며 알게된 사실들

코딩 주석

by exdus3156 2023. 11. 1.

코딩을 할 때 주석을 달라는 말을 많이 듣는다.

 

주석이 있어야만 다른 사람이 코드를 이해할 수 있고, 미래의 나에게도 도움이 된다는 것이다.

 

물론 코드가 그 자체로서 요구사항을 충실히 반영하고 쉽게 읽혀진다면 주석이 필수는 아닐 것이다.

 

그러나 그렇다고 주석을 빼서는 안 된다고 한다.

 

즉, 주석은 처음부터 타인과의 소통과 협업을 위해 만들어진 도구다.

 

지금 혼자 독학하고 있는 나로서는 타인이 나의 코드를 바라보는 관점을 획득하기 힘든 환경이다.

 

마틴의 <클린 코드>에서는 주석의 중요성을 강조한다.

 

그래서 한동안 주석 작성법을 열심히 배웠지만, 당연히 소용이 없었다.

 

왜냐하면 주석 다는 법은 술()의 영역이고, 주석의 도(道)는 타인이 코드를 어떻게 읽고 해석하는지 그 관점을 획득하는 것에 있기 때문이다.

 

당연히 술은 빠르게 희석되고 사라진다. 도가 중요하다.

 

하지만 나에겐 아직 그럴 환경이 아닌 것 같다. 타인과의 소통이 요구된다. 주석 공부는 뒤로 미루자.