"런타임 예외는 문서화" 에 대해서
474
작성한 질문수 1
[질문 템플릿]
1. 강의 내용과 관련된 질문인가요? (예)
2. 인프런의 질문 게시판과 자주 하는 질문에 없는 내용인가요? (예)
3. 질문 잘하기 메뉴얼을 읽어보셨나요? (예)
[질문 내용]
여기에 질문 내용을 남겨주세요.
안녕하세요. 런타임 예외는 문서화에 대한 내용을 보고 적용하려던 중 궁금증이 생겨 질문드립니다.
체크 예외의 경우 이미 클래스가 해당 예외에 대해 의존하기 때문에 자바독의 @throws를 통해 예외를 문서화하는데 문제가 없습니다.
런타임 예외의 경우 의존하지 않는다면, 자바독의 @throws를 통해 런타임 예외임을 표시하면(예시의 JPA EntityManager 방식과 같이) 해당 예외에 대한 의존이 추가됩니다.
이는 변경에 의해 영향을 받는 관계(의존)라고 볼 수 있는데, 어떻게 생각하시나요?
답변 1
0
안녕하세요, 인프런 AI 인턴이에요.
런타임 예외를 문서화하기 위해서 자바독의 @throws를 사용하는 것은 일반적인 방법입니다. 체크 예외와 마찬가지로 런타임 예외를 발생시키는 메소드를 사용할 때에도 @throws를 사용하여 해당 예외를 문서화하는 것이 좋습니다.
런타임 예외의 경우 프로그래머가 예외 처리를 강제하지 않기 때문에, 런타임 예외에 의존하지 않는다면 @throws를 사용할 때 주의가 필요합니다. 예를 들어 JPA EntityManager 방식으로 런타임 예외를 사용하는 경우, 해당 예외와 관련된 의존성이 추가될 수 있습니다.
이러한 의존성은 변경에 의해 영향을 받는 관계(의존)로 볼 수 있습니다. 따라서 의존성 관리를 위해서는 런타임 예외를 문서화할 때 주의가 필요하며, 런타임 예외에 따른 부작용이 발생할 수 있는 경우에는 문서화하고 예외 처리를 추가하는 것이 좋습니다.
하지만, 런타임 예외에 대한 의존성을 추가하는 것은 개발자의 판단에 따라 달라질 수 있습니다. 프로젝트의 협업 규칙이나 코드 품질 기준에 따라 결정하실 수 있을 것 같아요.
더 자세한 내용을 알고 싶으시다면, 자바독 문서나 관련된 예제 코드를 참고하시는 것이 좋을 것 같아요. 문서화의 목적과 프로젝트의 요구사항을 고려하여 적절한 유지보수 방향을 선택하시기 바랍니다.
더 궁금한 사항이 있으시다면 언제든지 물어보세요. 좋은 하루 되세요!
spring initialiser 어떤걸 선택해야될지 모르겠어요
0
38
2
트랜잭션 템플릿이 체크예외는 커밋하는 이유가 궁금합니다.
0
51
1
jdbc 학습하다 궁금해서 질문드려요
0
85
1
정상이체와 이체중 예외발생 차이
0
70
2
이번 강의부터가 JDBC 직접 사용 맞나요?
0
89
1
순수한 서비스 계층에 대한 의문???
0
83
2
3_4test, 4test 자동 리소스 안됨
0
59
2
데이터베이스 선택 관련 질문.
0
71
2
after 메서드 사용 유무
0
60
2
데이터베이스 접근 및 DB 락
0
57
1
@SpingBootTest, @TestConfiguration
0
57
1
Read Committed 격리 수준 사용 관련 질문
0
50
1
AopCheck Test 부분의 EnhancerBySpring 확인 법??
0
69
2
커리큘럼 관련 질문
0
78
1
서비서 계층 스프링 프레임워크 사용
0
89
1
validation(toMember)의 위치
0
84
2
데이터 계층에서 서비스 로직의 datasource를 인식하는 방법
0
166
2
member 상수 질문
0
124
2
ctrl + F6 이후로 con 인식이 안 됩니다
0
154
2
DrivenManager 와 Connection 반환에 대한 질문입니다!
0
110
1
섹션5 트랜잭션 템플릿관련 질문(이기종 DB)
0
116
1
세션1 테이블 조회결과 그림은 Redo 로그에 속하나요?
0
103
1
트랜잭션이 필요하지 않은 경우 DB 대신 파일 시스템을 사용하는 것이 더 효율적인가?
0
98
1
강의 14분쯤 Exception 질문
0
116
2