Development Diary

Item56에서는 공개된 API 요소에는 항상 문서화 주석을 작성하라 말한다 사실 언어나 프레임워크, 공개 라이브러리 작성자가 아니라면 지키지 않아도 될 조언이긴 하다 다만 구멍가게를 벗어나 네이버와 같이 하나의 회사지만 여러 계열사로 나뉘고 그 안에서 공통적으로 사용할 모듈을 개발한다면 의무는 아니어도 javadoc 형태로 작성해두면 사용하는 이들에게 좋다 나는 수습 과제로 만든 작은 사이드 프로젝트에 주석을 적어놓기도 했다 클린 코드에 미친 사람이라면 주석 자체가 쓰레기 같겠지만 분명한 건 코드를 짜는 순간부터 레거시가 되고 자신이 평생 유지보수할 수는 없다는 것이다 그렇다면 다음 사람이 이를 맡아서 유지보수를 해야 하는데 도메인 지식이라고도 하고, 배경지식이라고도 하는 특정 비지니스 로직을 모르고 ..