Javadoc 자바독 자바주석 주석 Comment

자바에서 주석 다는 방법: Javadoc 이란 무엇일까? (Feat. 위키피디아)

Javadoc 이란? 선 마이크로 시스템즈에서 개발한 문서 생성기이다. 자바 소스코드로 HTML 포맷의 API 문서를 생성한다. HTML 로 생성하는 이유는 하이퍼링크를 편하게 달기 위함이다. 컴파일 타임에는 모두 지워지니 성능 걱정은 할 필요 없다. 작성된 자바 코드를 잘 이해하고 유지보수 하기 위함이 목적이다. 역사 이전에는 소프트웨어에 대한 독립형 문서를 작성할 Technical writers 를 고용했는데, 문서와 소프트웨어의 싱크를 유지하는 것은 매우 어려운 일이었다. 그래서 문서 생성기인 Javadoc 이 쓰이게 되었다. 자바의 첫 릴리즈 이래로 Javadoc 은 계속 쓰였고, JDK의 새 릴리즈마다 업데이트 됐다. 다른 언어의 문서 시스템에서 @field 문법을 모방하였다. 기술적인 구조 J..