refactor: 코드 설명을 위한 주석 및 JavaDocs 추가 완료

[SongJaeHoonn]

Summary

#493

프로젝트 규모가 커짐에 따라 전 도메인 이해가 어려워지고 있으며, 신규 팀원의 빠른 적응을 위해 기본 CRUD를 제외한 복잡도 있는 메소드에 대해 JavaDocs와 주석이 필요했습니다.

또한, 시간이 지나면서 레거시가 될 가능성이 큰 만큼, 작업 의도나 도메인 규칙을 쉽게 파악할 수 있어야 했기에 Application 레이어의 메소드, 그리고 Filter, Util 클래스 등 핵심적이고 공통으로 사용되는 클래스에 JavaDocs 또는 주석을 작성했습니다.

Tasks

• 코드베이스 전반 JavaDocs 및 코드의 흐름을 나타내는 주석 작성

ETC

커밋을 보면, // 주석을 달아 둔 부분과 JavaDocs를 사용한 부분이 있습니다.

// 주석을 달아둔 부분

• 한 클래스에 비교적 메서드의 수가 많아 JavaDocs를 사용했을 때 오히려 가독성이 떨어지는 경우
• 같은 클래스에 있는 비슷한 메서드의 차이를 설명해야 하는 경우

JavaDocs를 사용한 부분

• 한 눈에 봤을 때 서비스의 흐름을 파악하기 매우 어려운 경우
• 한 메서드에 코드의 양이 많고 복잡해 가독성이 떨어지는 경우
• 한 클래스에 비교적 메서드의 수가 적어 JavaDocs를 사용하더라도 가독성이 떨어지지 않는 경우
• 프로젝트에서 공통으로 사용되는 Filter 및 Util 클래스

[mingmingmon]

확인했습니다! 👍👍

[limehee]

@code와 @link 같은 주석 어노테이션을 적절히 활용해, 한눈에 이해하기 쉽게 정리해주신 부분이 인상 깊네요. 코드베이스 전반을 꼼꼼하게 검토하며 주석을 작성하시느라 고생 많으셨습니다.