학습시간 09:00~02:00(당일17H/누적2392H)

◆ 일지

좋은 주석이란

서비스 개발을 마치고 코드를 정돈하고 있다. 최대한 가독성 좋은 방향으로 주석을 달고 있는데, 문득 좋은 주석이란 뭘까? 하는 생각이 들었다. 이쪽 업계가 하루이틀 된 것도 아니니, 개발자들 사이에서 관례적으로 이어져 내려온 주석 다는 방법 같은 게 분명 있지 않을까. 강의에서 주석 방법론 같은 것을 배우지 않기도 했고, 그동안 내가 짠 코드만 보다 보니 주석을 잘 달지 않았는데, 확실히 다른 사람의 코드를 주석 없이 보려니 난감한 부분이 꽤 있었다. 리딩에 시간도 오래 걸릴 뿐만 아니라 다른 파일에서 import라도 해온 함수면 그 함수를 추상적으로 생각하며 접근할 수밖에 없었다. 귀찮긴 하지만 습관처럼 주석을 달아야겠다는 생각이 들었다. 인간관계의 기본이 소통이듯 개발자 간의 기본은 주석이리라. 주석도 프로그래밍 언어마다 모양새가 조금씩 다른데 통상적인 법칙은 있는 듯하다. 모듈 독스트링, 함수 독스트링, 섹션 주석, 인라인 주석, 키워드 주석(TODO, FIXME, NOTE, HACK, REVIEW 등) 이것만 잘해도 반은 먹고 들어가는 것 같다. 게다가 코드가 어떤 기능을 담당하는지보다는 무엇과 상호작용하며 어떤 이유로 코드를 이렇게 구성했는지 위주로 적는 게 더 좋다고 한다. 주석도 공부해 보니 꽤나 흥미로운 부분이 있다. 나 이런 거 좋아하네.