gradle

언제까지 문서를 직접 작성할꺼야? Javadoc로 문서를 한 번에 끝내자! Javadoc이란 주석으로 작성된 코드 문서를 HTML 문서로 만들어주는 도구다. 필자는 Gradle를 사용했기 때문에, IDEA Terminal에서 아래의 명령어를 날려주면 자동으로 문서화된다. ./gradlew javadoc 생성된 문서는 /build 디렉토리에 만들어지며, app/build/docs/javadoc/index.html을 브라우저에서 열면 문서를 확인할 수 있다. index.html을 열어봤는데 딱히 내용이 없다고? Javadoc는 소스 코드에 작성한 주석을 기반으로 문서를 만들어준다. 그래서, Javadoc 용 주석을 사용해야 한다. 보통 주석을 작성함에 있어서 사용하는 주석은 아래와 같다. // 이 주석은 한..