IT/Programming
<Effective Java> RULE 44 모든 API요소에 문서화 주석을 달라
좋은 API문서를 만들려면 API에 포함된 모든 클래스, 인터페이스, 생성자, 메서드, 그리도 필드 선언에 문서화 주석을 달아야한다. · 계승을 위해 설계된 메서드가 아니라면 메서드가 무엇을 하는지를 설명해야하며 어떻게 그 일을 하는지 설명해서는 안된다. · 해당 메서드모든 선행조건과 후행조건을 나열해야한다. ㄴ 선행조건 : 클라이언트가 메서드를 호출하려면 반드시 참이어야 하는 조건 · 무점검 예외에 대한 @Throws, @Param태그를 통해 명시할 수 있다. ㄴ 후행조건 : 메서드 실행이 성공적으로 끈난 다음에 만족되어야 하는 조건 · 부작용에 대해서 문서화 해야한다. ㄴ 후면 쓰레드를 실행한다면 문서는 그 사실을 명시해야 한다. · 클래스나 메서드의 스레드 안전성에 대해 문서화해야한다. /** * ..
2023. 4. 26. 13:39