프로그래밍 주석의 필요성

예전에 만들어 놓았던 증권사 api 시스템에 추가 기능을 구현하기 위해

과거 구현했었던 내용을 열어봤는데 당시 직관적으로 구현해서 이해하기 쉽다고 생각했던

나의 생각을 완전히 뒤집었다. 

 

[증권사 api를 이용한 파이썬 코드]

심지어 함수가 어떤 기능을 수행하는지 그리고 어떤 로직으로 동작하는지 한 눈에 들어오지도 않는다.

학부 수업을 들었을 때, 그리고 잠시 실무를 경험하며 주석의 필요성을 지겹도록 들었다.

 

   1. 코드의 이해를 도와 유지보수가 편해진다.

   2. 협업 시 효율성을 증진시켜준다.

   3. 개발 속도, 개발의 질이 향상된다.

 

 

누구나 아는 장점이지만 혼자 하는 프로그래밍, 내가 한 부분은 다 기억할 거라 자만했었다.

주석을 추가하느라 오늘 하루가 몽땅 희생되었다. 참혹한 결과가 아닐 수 없다.

앞으로 개발하면서 주석을 꼭 달아야겠다고 명심한다.

[꼬박 하루를 날린 결과물]