JavaDoc을 통한 Spring Level 3 문서화

---

학습 계기

---

Spring 프로젝트의 문서화는 중요하지만 수작업으로 하기에는 너무 비효율적이다.
그러던 중 기술 매니저님의 권유로 알게된 JavaDoc이란 것에 대해 알게 되었다.
JavaDoc을 이용해 Spring Level 3의 일부를 문서화해보도록 하겠다.

---

JavaDoc 일부 진행

---

UserService

먼저 전체를 문서화하지 않고 일부만 진행하기로 하였다.

JavaDoc은 주로 아래와 같은 형태로 사용한다.

/**
* 설명
*
*/

UserService 클래스는 회원 관련 기능들을 주로 처리하는 서비스 클래스로 이를 통해 회원가입, 로그인 및 권한 확인 등의 기능을 관리한다.

이렇게 작성된 JavaDoc을 실제로 문서화하기 위해서는 프로젝트 폴더에서 다음과 같은 명령어를 실행한다.

$ ./gradlew javadoc

---

문서화 샘플

---

---

최종 문서화 파일

---

GitHub SpringLevel3

---

트러블 슈팅

---

1. JAVA_HOME 환경 변수 설정 문제

   ERROR: JAVA_HOME is set to an invalid directory: C:\Program Files\Java\jdk-17.0.1\bin

   JAVA_HOME 환경변수가 올바르게 설정되지 않아 발생한 문제다. 해당 환경변수를 적절히 설정하고 다시 시도해보았다.

2. 한글 인코딩 문제
   해당 문제를 해결하기 위해 build.gradle에 UTF-8 인코딩 설정을 추가하였다.
   

tasks.withType(JavaCompile) {
    options.encoding = 'UTF-8'
}

tasks.withType(Javadoc) {
    options.encoding = 'UTF-8'
}

---