주석을 사용해야 하는 상황에서는, 가능하면 상세히 다세요. 복잡한 주석을 달 정도의 상황을 만들지 말라는 뜻은 처음부터 논리구조를 잘 설계하라는 뜻입니다. 즉 기본적으로 기획 단에서 잘 설계하라는 뜻이죠. 기획자가 똑바로 설계해서 주면 프로그래머가 돌아가서 코딩을 할 일이 없습니다. 그러면 코드도 깔끔하고 주석도 생길일이 없겠죠. 기획자가 개판으로 설계하고 프로그래머가 클레임 걸어도 강행하면 어쩔 수 없습니다. 결과물도 개판이고 그렇기 때문에 주니어든 시니어든 만일을 대비해서 주석을 사용해야만 합니다. 즉 프로그래머가 주석을 사용하는 건 언제나 어쩔 수 없는 케이스이기 때문입니다. 어느정도 프로그래밍을 하고 나면, 누구나 주석을 사용할 때는 중요하다고 여기는 부분에서만 주석을 달곤 합니다. 꼭 코드창에 작성하지 않더라도 슬랙에 남기든 종이로 적든 팀원에게 소통하든 그게 다 주석의 다른 형태이구요. 손가락으로 달을 가르키면 사람들이 손톱만 가지고 아 손톱을 저렇게 관리해야하는 거구나 이런 분들이 있습니다. 주석은 그냥 응급상황에서 구급법을 해줘야 한다 이런 당연한 대응방식에 불과합니다. 애초에 응급상황을 만들지 않도록 해야한다는 것이 본질입니다.
#프로그래밍 #주석
반응형