39일차 JavaDoc주석에 대하여

1. 오늘의 학습 키워드

JavaDoc

2. 학습 내용
JavaDoc 주석에 대하여
이전 프로젝트에서 다른 프로젝트를 구경하다가 주석을 다는 방식을 참고해서 작성해보았는데
이 것이 JavaDoc이라는 개념이라는 것을 알게되었다
그래서 정확히 어떤 것인지 알아보고 왜 사용하는지 찾아보았다 

3. 학습하며 정리한 내용 요약
 JavaDoc은 Java 소스 코드로부터 API 문서를 생성하는 도구

JavaDoc의 중요성:

• API 문서화: 라이브러리나 프레임워크를 개발할 때 API 사용 방법을 명확하게 전달하는 중요한 수단이다.
• 코드 이해도 향상: 코드 작성자와 사용자 모두에게 코드의 목적, 사용법, 주의사항 등을 명확하게 제공하여 이해도를 높인다.
• 유지보수 용이성: 시간이 흘러 코드가 변경되더라도 JavaDoc을 통해 최신 API 정보를 유지할 수 있어 유지보수에 도움이 된다.
• 협업 효율 증대: 여러 개발자가 함께 작업할 때 API 스펙을 명확하게 공유하여 협업 효율성을 높인다.

해당 중요성을 참고하여 JavaDoc을 이용했을 때 어떻게 작성하는 것이 좋게 작용할까 고민하게 되었다

https://t-era.tistory.com/221

4. 내일 학습 키워드
 JAVADOC으로 주석작성해보기