목록API주석 (1)

기록이 힘이다.

[이펙티브 자바] 56. 공개된 API 요소에는 항상 문서화 주석을 작성하라

문서화 주석을 작성하는 규칙은 공식 언어 명세에 속하진 않지만 자바 프로그래머라면 응당 알아야 하는 업계 표준 API라 할 수 있다. 여러분의 API를 올바로 문서화하려면 공개된 모든 클래스, 인터페이스, 메서드, 필드 선언에 문서화 주석을 달아야 한다. 메서드용 문서화 주석에는 해당 메서드와 클라이언트 사이의 규약을 명료하게 기술해야 한다. @throw태그로 비검사 예외를 선언, @param태그를 이용해 그 조건에 영향받는 매개변수에 기술 전제조건과 사후조건뿐만 아니라 부작용도 문서화해야 한다. ex) 백그라운드 스레드를 시작시키는 메서드 메서드의 계약을 완벽히 기술하려면 모든 매개변수에 @param 태그를, 반환 타입이 void가 아니라면 @return 태그를, 발생할 가능성이 있는 (검사든 비검사든..
JAVA 2023. 4. 19. 07:33
이전 Prev 1 Next 다음