03016_TIL

* 어제의 다짐

- 이펙티브 자바 1강

=> 자바 asciidocs의 실행이 제대로 되지 않아 못함 

 

- 자바 주석 달기

=> controller, service에만 있던 주석들을 다른 곳도 확정해서 작성

 

- docker 사용해보고 실행확인하기

=> 자바 asciidocs의 실행이 제대로 되지 않아 못함

 

*오늘 한 일

-javadocs를 위한 주석을 추가하였습니다. ./gradlew javadoc을 통해 우리가 documentation을 보는 것처럼 나의 프로젝트를 공식 문서 형식으로 볼 수 있습니다. 기존에는 controller, service에만 일부 주석이 있었기 때문에 전체적으로 주석을 추가하였습니다. 한글로 작성하였으며, 방식은 공식문서에서 영어를 한글로 번역했을 때 가장 자연스러우면서 추상적인 의미를 담기 위해 노력했습니다. 각 클래스의 전체주석도 추가하였는데, 이는 javadocs를 열었을 때, Description에 내용을 올바르게 추가하기 위한 것입니다.

 

-@Transactional이 제대로 되지 않았던 부분을 수정했습니다. 기존에 update와 delete가 정상적으로 되지 않았습니다. terminal에서는 제대로 반영이된 것처럼 보였는데 막상 h2에서 확인해보니 아무것도 변화가 안됐습니다. 이유는 Repository에서 불러온 객체를 Data로 전화하여 조회한 다음, 또다시 변경을 위해 Entity로 만들었기 때문이었습니다. 따라서 조회 메서드의 리턴형을 Entity로 바꾸었고 정상적으로 수정과 삭제가 되었습니다.

 

*내일 할 일

- Spring Docs 문서화하기