-
질문 & 답변
카테고리
-
세부 분야
백엔드
-
해결 여부
미해결
"런타임 예외는 문서화" 에 대해서
23.07.24 17:40 작성 조회수 336
0
[질문 템플릿]
1. 강의 내용과 관련된 질문인가요? (예)
2. 인프런의 질문 게시판과 자주 하는 질문에 없는 내용인가요? (예)
3. 질문 잘하기 메뉴얼을 읽어보셨나요? (예)
[질문 내용]
여기에 질문 내용을 남겨주세요.
안녕하세요. 런타임 예외는 문서화에 대한 내용을 보고 적용하려던 중 궁금증이 생겨 질문드립니다.
체크 예외의 경우 이미 클래스가 해당 예외에 대해 의존하기 때문에 자바독의 @throws를 통해 예외를 문서화하는데 문제가 없습니다.
런타임 예외의 경우 의존하지 않는다면, 자바독의 @throws를 통해 런타임 예외임을 표시하면(예시의 JPA EntityManager 방식과 같이) 해당 예외에 대한 의존이 추가됩니다.
이는 변경에 의해 영향을 받는 관계(의존)라고 볼 수 있는데, 어떻게 생각하시나요?
답변을 작성해보세요.
0
인프런 AI 인턴
2023.07.26
안녕하세요, 인프런 AI 인턴이에요.
런타임 예외를 문서화하기 위해서 자바독의 @throws를 사용하는 것은 일반적인 방법입니다. 체크 예외와 마찬가지로 런타임 예외를 발생시키는 메소드를 사용할 때에도 @throws를 사용하여 해당 예외를 문서화하는 것이 좋습니다.
런타임 예외의 경우 프로그래머가 예외 처리를 강제하지 않기 때문에, 런타임 예외에 의존하지 않는다면 @throws를 사용할 때 주의가 필요합니다. 예를 들어 JPA EntityManager 방식으로 런타임 예외를 사용하는 경우, 해당 예외와 관련된 의존성이 추가될 수 있습니다.
이러한 의존성은 변경에 의해 영향을 받는 관계(의존)로 볼 수 있습니다. 따라서 의존성 관리를 위해서는 런타임 예외를 문서화할 때 주의가 필요하며, 런타임 예외에 따른 부작용이 발생할 수 있는 경우에는 문서화하고 예외 처리를 추가하는 것이 좋습니다.
하지만, 런타임 예외에 대한 의존성을 추가하는 것은 개발자의 판단에 따라 달라질 수 있습니다. 프로젝트의 협업 규칙이나 코드 품질 기준에 따라 결정하실 수 있을 것 같아요.
더 자세한 내용을 알고 싶으시다면, 자바독 문서나 관련된 예제 코드를 참고하시는 것이 좋을 것 같아요. 문서화의 목적과 프로젝트의 요구사항을 고려하여 적절한 유지보수 방향을 선택하시기 바랍니다.
더 궁금한 사항이 있으시다면 언제든지 물어보세요. 좋은 하루 되세요!
답변 1